Interface to a flow in a network. More...

Inheritance diagram for Satsuma.IFlow< TCapacity >:

Public Member Functions
TCapacity	Flow (Arc arc)
	The amount flowing through an arc. More...

Properties
Func< Arc, TCapacity >	Capacity `[get]`
	The capacity of the arcs. More...

TCapacity	FlowSize `[get]`
	The total amount of flow exiting the source node. More...

IGraph	Graph `[get]`
	The graph of the network. More...

IEnumerable< KeyValuePair< Arc, TCapacity > >	NonzeroArcs `[get]`
	Those of the arcs where there is nonzero flow. More...

Node	Source `[get]`
	The source of the flow. More...

Node	Target `[get]`
	The target (sink) of the flow. More...

Detailed Description

Interface to a flow in a network.

Edges work as bidirectional channels, as if they were two separate arcs.

Template Parameters

TCapacity The arc capacity type.

Definition at line 34 of file Preflow.cs.

Member Function Documentation

TCapacity Satsuma.IFlow< TCapacity >.Flow ( Arc arc )

The amount flowing through an arc.

Returns: A number between 0 and Capacity(arc) if the arc is NOT an edge, or between -Capacity(arc) and Capacity(arc) if the arc is an edge.

Func<Arc, TCapacity> Satsuma.IFlow< TCapacity >.Capacity

get

The capacity of the arcs.

Must be nonnegative (including positive infinity, if applicable).

Definition at line 40 of file Preflow.cs.

TCapacity Satsuma.IFlow< TCapacity >.FlowSize

get

The total amount of flow exiting the source node.

Definition at line 46 of file Preflow.cs.

IGraph Satsuma.IFlow< TCapacity >.Graph

get

The graph of the network.

Definition at line 37 of file Preflow.cs.

IEnumerable<KeyValuePair<Arc, TCapacity> > Satsuma.IFlow< TCapacity >.NonzeroArcs

get

Those of the arcs where there is nonzero flow.

For each nonzero arc, yields a pair consisting of the arc itself and the flow value on the arc.

Definition at line 49 of file Preflow.cs.

Node Satsuma.IFlow< TCapacity >.Source

get

The source of the flow.

Definition at line 42 of file Preflow.cs.

Node Satsuma.IFlow< TCapacity >.Target

get

The target (sink) of the flow.

Definition at line 44 of file Preflow.cs.

The documentation for this interface was generated from the following file: