Class EdmondsKarpMaximumFlowAlgorithm<TVertex, TEdge>

Edmond and Karp maximum flow algorithm for directed graph with positive capacities and flows.

Inheritance
System.Object
AlgorithmBase<IMutableVertexAndEdgeListGraph<TVertex, TEdge>>
MaximumFlowAlgorithm<TVertex, TEdge>
EdmondsKarpMaximumFlowAlgorithm<TVertex, TEdge>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: QuikGraph.Algorithms.MaximumFlow
Assembly: QuikGraph.dll
Syntax
public sealed class EdmondsKarpMaximumFlowAlgorithm<TVertex, TEdge> : MaximumFlowAlgorithm<TVertex, TEdge>, IAlgorithm<IMutableVertexAndEdgeListGraph<TVertex, TEdge>>, IComputation, IAlgorithmComponent, IVertexColorizerAlgorithm<TVertex> where TEdge : IEdge<TVertex>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.

Constructors

| Improve this Doc View Source

EdmondsKarpMaximumFlowAlgorithm(IAlgorithmComponent, IMutableVertexAndEdgeListGraph<TVertex, TEdge>, Func<TEdge, Double>, EdgeFactory<TVertex, TEdge>, ReversedEdgeAugmentorAlgorithm<TVertex, TEdge>)

Initializes a new instance of the EdmondsKarpMaximumFlowAlgorithm<TVertex, TEdge> class.

Declaration
public EdmondsKarpMaximumFlowAlgorithm(IAlgorithmComponent host, IMutableVertexAndEdgeListGraph<TVertex, TEdge> visitedGraph, Func<TEdge, double> capacities, EdgeFactory<TVertex, TEdge> edgeFactory, ReversedEdgeAugmentorAlgorithm<TVertex, TEdge> reverseEdgesAugmentorAlgorithm)
Parameters
Type Name Description
IAlgorithmComponent host

Host to use if set, otherwise use this reference.
IMutableVertexAndEdgeListGraph<TVertex, TEdge> visitedGraph

Graph to visit.
System.Func<TEdge, System.Double> capacities

Function that given an edge return the capacity of this edge.
EdgeFactory<TVertex, TEdge> edgeFactory

Edge factory method.
ReversedEdgeAugmentorAlgorithm<TVertex, TEdge> reverseEdgesAugmentorAlgorithm

Algorithm that is in of charge augmenting the graph (creating missing reversed edges).
Exceptions
Type Condition
System.ArgumentNullException

visitedGraph is null.
System.ArgumentNullException

capacities is null.
System.ArgumentNullException

edgeFactory is null.
System.ArgumentNullException

reverseEdgesAugmentorAlgorithm is null.
System.ArgumentException

reverseEdgesAugmentorAlgorithm targets a graph different from visitedGraph.
| Improve this Doc View Source

EdmondsKarpMaximumFlowAlgorithm(IMutableVertexAndEdgeListGraph<TVertex, TEdge>, Func<TEdge, Double>, EdgeFactory<TVertex, TEdge>, ReversedEdgeAugmentorAlgorithm<TVertex, TEdge>)

Initializes a new instance of the EdmondsKarpMaximumFlowAlgorithm<TVertex, TEdge> class.

Declaration
public EdmondsKarpMaximumFlowAlgorithm(IMutableVertexAndEdgeListGraph<TVertex, TEdge> visitedGraph, Func<TEdge, double> capacities, EdgeFactory<TVertex, TEdge> edgeFactory, ReversedEdgeAugmentorAlgorithm<TVertex, TEdge> reverseEdgesAugmentorAlgorithm)
Parameters
Type Name Description
IMutableVertexAndEdgeListGraph<TVertex, TEdge> visitedGraph

Graph to visit.
System.Func<TEdge, System.Double> capacities

Function that given an edge return the capacity of this edge.
EdgeFactory<TVertex, TEdge> edgeFactory

Edge factory method.
ReversedEdgeAugmentorAlgorithm<TVertex, TEdge> reverseEdgesAugmentorAlgorithm

Algorithm that is in of charge of augmenting the graph (creating missing reversed edges).
Exceptions
Type Condition
System.ArgumentNullException

visitedGraph is null.
System.ArgumentNullException

capacities is null.
System.ArgumentNullException

edgeFactory is null.
System.ArgumentNullException

reverseEdgesAugmentorAlgorithm is null.
System.ArgumentException

reverseEdgesAugmentorAlgorithm targets a graph different from visitedGraph.

Methods

| Improve this Doc View Source

Initialize()

Called on algorithm initialization step.

Declaration
protected override void Initialize()
Overrides
QuikGraph.Algorithms.AlgorithmBase<QuikGraph.IMutableVertexAndEdgeListGraph<TVertex, TEdge>>.Initialize()
| Improve this Doc View Source

InternalCompute()

Computes the maximum flow between Source and Sink.

Declaration
protected override void InternalCompute()
Overrides
QuikGraph.Algorithms.AlgorithmBase<QuikGraph.IMutableVertexAndEdgeListGraph<TVertex, TEdge>>.InternalCompute()

Implements

Extension Methods