fr.inria.opengve.bridge.algorithms.common
Class AugmentingPath<V,E extends Link<V>,G extends Graph<V,E>>

java.lang.Object
  fr.inria.opengve.bridge.algorithms.common.AugmentingPath<V,E,G>

public abstract class AugmentingPath<V,E extends Link<V>,G extends Graph<V,E>>
extends java.lang.Object

This class construct augmenting path on a graph. This class is for example used in the class EdmondsKarp. The use of this class begin by is initialization.

• Set capacity access informations :
  • setCapacityMap(Map)
  • setCapacityName(String)
  • setCapacityContext(Object)
• Set cost information :
  • setCostMap(Map)
  • setCostName(String)
  • setCostContext(Object).

    You can set the map cost to null for a cost of one for all edges.

    After this initialization each call to getBestPath(Object,Object) return the path between two vertices with a minimum cost. You can get the quantity of flow used by the last returned Path with getFlow().

    Author:

    fabrice.peix@sophia.inria.fr

    Constructor Summary

    AugmentingPath(G g)
    Constructor of AugmentingPath flow algorithm.

    Method Summary

    protected abstract AbstractScalar	createInteger(int value) Create a new AbstractScalar (Integer type).
    protected abstract Path<V,E>	createPath() Create a new empty path of the same type that graph g.
    Path<V,E>	getBestPath(V source, V destination) Return the shortest path (in term of cost) with the maximum quantity of flow.
    AbstractScalar	getFlow() Return the value of flow of the last retured path.
    void	setCapacityContext(java.lang.Object capacityContext) Set the context used to load capacity in the map.
    void	setCapacityMap(Map capacityMap) Set the map used to load capacity.
    void	setCapacityName(java.lang.String capacityName) Set the name used to load capacity in the map.
    void	setCostContext(java.lang.Object costContext) Set the context used to load cost in the map.
    void	setCostMap(Map costMap) Set the map used to load cost.
    void	setCostName(java.lang.String costName) Set the name used to load cost in the map.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Constructor Detail

    AugmentingPath

    public AugmentingPath(G g)

    Constructor of AugmentingPath flow algorithm.

    Parameters:

    g - The graph.

    Method Detail

    createPath

    protected abstract Path<V,E> createPath()

    Create a new empty path of the same type that graph g.

    Returns:

    A new empty path.

    createInteger

    protected abstract AbstractScalar createInteger(int value)

    Create a new AbstractScalar (Integer type).

    Parameters:

    value - The value of the new AbstractScalar.

    Returns:

    The new created AbstractScalar.

    setCapacityMap

    public void setCapacityMap(Map capacityMap)

    Set the map used to load capacity.

    Parameters:

    capacityMap - The map used to load capacity.

    setCapacityName

    public void setCapacityName(java.lang.String capacityName)

    Set the name used to load capacity in the map.

    Parameters:

    capacityName - The name used to load capacity in the map.

    setCapacityContext

    public void setCapacityContext(java.lang.Object capacityContext)

    Set the context used to load capacity in the map. Use null to specify default context value.

    Parameters:

    capacityContext - The context used to load capacity in the map.

    setCostMap

    public void setCostMap(Map costMap)

    Set the map used to load cost.

    Parameters:

    costMap - The map used to load cost.

    setCostName

    public void setCostName(java.lang.String costName)

    Set the name used to load cost in the map.

    Parameters:

    costName - The name used to load cost in the map.

    setCostContext

    public void setCostContext(java.lang.Object costContext)

    Set the context used to load cost in the map. Use null to specify default context value.

    Parameters:

    costContext - The context used to load cost in the map.

    getBestPath

    public Path<V,E> getBestPath(V source,
                                 V destination)

    Return the shortest path (in term of cost) with the maximum quantity of flow.

    Returns:

    The best path.

    getFlow

    public AbstractScalar getFlow()

    Return the value of flow of the last retured path.

    Returns:

    The value of flow.