capacity_scaling(G, demand='demand', capacity='capacity', weight='weight', heap=<class 'networkx.utils.heaps.BinaryHeap'>)
This is a capacity scaling successive shortest augmenting path algorithm.
G is a digraph with edge costs and capacities and in which nodes have demand, i.e., they want to send or receive some amount of flow. A negative demand means that the node wants to send flow, a positive demand means that the node want to receive flow. A flow on the digraph G satisfies all demand if the net flow into each node is equal to the demand of that node.
This algorithm does not work if edge weights are floating-point numbers.
DiGraph or MultiDiGraph on which a minimum cost flow satisfying all demands is to be found.
Nodes of the graph G are expected to have an attribute demand that indicates how much flow a node wants to send (negative demand) or receive (positive demand). Note that the sum of the demands should be 0 otherwise the problem in not feasible. If this attribute is not present, a node is considered to have 0 demand. Default value: 'demand'.
Edges of the graph G are expected to have an attribute capacity that indicates how much flow the edge can support. If this attribute is not present, the edge is considered to have infinite capacity. Default value: 'capacity'.
Edges of the graph G are expected to have an attribute weight that indicates the cost incurred by sending one unit of flow on that edge. If not present, the weight is considered to be 0. Default value: 'weight'.
Type of heap to be used in the algorithm. It should be a subclass of MinHeap
or implement a compatible interface.
If a stock heap implementation is to be used, BinaryHeap
is recommended over PairingHeap
for Python implementations without optimized attribute accesses (e.g., CPython) despite a slower asymptotic running time. For Python implementations with optimized attribute accesses (e.g., PyPy), PairingHeap
provides better performance. Default value: BinaryHeap
.
This exception is raised if the input graph is not directed, not connected.
This exception is raised in the following situations:
The sum of the demands is not zero. Then, there is no flow satisfying all demands.
There is no flow satisfying all demand.
This exception is raised if the digraph G has a cycle of negative cost and infinite capacity. Then, the cost of a flow satisfying all demands is unbounded below.
Cost of a minimum cost flow satisfying all demands.
If G is a digraph, a dict-of-dicts keyed by nodes such that flowDict[u][v] is the flow on edge (u, v). If G is a MultiDiGraph, a dict-of-dicts-of-dicts keyed by nodes so that flowDict[u][v][key] is the flow on edge (u, v, key).
Find a minimum cost flow satisfying all demands in digraph G.
network_simplex
meth
A simple example of a min cost flow problem.
>>> G = nx.DiGraph()
... G.add_node("a", demand=-5)
... G.add_node("d", demand=5)
... G.add_edge("a", "b", weight=3, capacity=4)
... G.add_edge("a", "c", weight=6, capacity=10)
... G.add_edge("b", "d", weight=1, capacity=9)
... G.add_edge("c", "d", weight=2, capacity=5)
... flowCost, flowDict = nx.capacity_scaling(G)
... flowCost 24
>>> flowDict {'a': {'b': 4, 'c': 1}, 'd': {}, 'b': {'d': 4}, 'c': {'d': 1}}
It is possible to change the name of the attributes used for the algorithm.
>>> G = nx.DiGraph()
... G.add_node("p", spam=-4)
... G.add_node("q", spam=2)
... G.add_node("a", spam=-2)
... G.add_node("d", spam=-1)
... G.add_node("t", spam=2)
... G.add_node("w", spam=3)
... G.add_edge("p", "q", cost=7, vacancies=5)
... G.add_edge("p", "a", cost=1, vacancies=4)
... G.add_edge("q", "d", cost=2, vacancies=3)
... G.add_edge("t", "q", cost=1, vacancies=2)
... G.add_edge("a", "t", cost=2, vacancies=4)
... G.add_edge("d", "w", cost=3, vacancies=4)
... G.add_edge("t", "w", cost=4, vacancies=1)
... flowCost, flowDict = nx.capacity_scaling(
... G, demand="spam", capacity="vacancies", weight="cost"
... )
... flowCost 37
>>> flowDict {'p': {'q': 2, 'a': 2}, 'q': {'d': 1}, 'a': {'t': 4}, 'd': {'w': 2}, 't': {'q': 1, 'w': 1}, 'w': {}}See :
The following pages refer to to this document either explicitly or contain code examples using this.
networkx.algorithms.flow.capacityscaling.capacity_scaling
Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.
Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)
SVG is more flexible but power hungry; and does not scale well to 50 + nodes.
All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them