diff options
| author | Jordi Torrents <jordi.t21@gmail.com> | 2014-04-14 15:20:44 +0200 |
|---|---|---|
| committer | Jordi Torrents <jordi.t21@gmail.com> | 2014-04-19 00:12:53 +0200 |
| commit | 79211e853f23a8fc6b021386335f275bbd5b6a72 (patch) | |
| tree | 9418e40fff935d1314ede6a0531705d0435c7ad6 /networkx/algorithms/flow/maxflow.py | |
| parent | fce574adce1701abb76ec7ea31d680bcdee97212 (diff) | |
| download | networkx-79211e853f23a8fc6b021386335f275bbd5b6a72.tar.gz | |
More docstring fixes.
Diffstat (limited to 'networkx/algorithms/flow/maxflow.py')
| -rw-r--r-- | networkx/algorithms/flow/maxflow.py | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/networkx/algorithms/flow/maxflow.py b/networkx/algorithms/flow/maxflow.py index 4d643153..1a2460b7 100644 --- a/networkx/algorithms/flow/maxflow.py +++ b/networkx/algorithms/flow/maxflow.py @@ -36,14 +36,13 @@ def maximum_flow(G, s, t, capacity='capacity', flow_func=None): attribute is not present, the edge is considered to have infinite capacity. Default value: 'capacity'. - flow_func : function (default=None) + flow_func : function A function for computing the maximum flow among a pair of nodes in a capacitated graph. The function has to accept three parameters: a Graph or Digraph, a source node, and a target node. And return the maximum flow value. If flow_func is None the default maximum - flow function - (:func:`networkx.algorithms.flow.preflow_push_value`) - is used. See below for alternative algorithms. + flow function (:func:`networkx.algorithms.flow.preflow_push_value`) + is used. See below for alternative algorithms. Default value: None. Returns ------- @@ -124,13 +123,13 @@ def minimum_cut(G, s, t, capacity='capacity', flow_func=None): attribute is not present, the edge is considered to have infinite capacity. Default value: 'capacity'. - flow_func : function (default=None) + flow_func : function A function for computing the maximum flow among a pair of nodes in a capacitated graph. The function has to accept three parameters: a Graph or Digraph, a source node, and a target node. And return the maximum flow value. If flow_func is None the default maximum flow function (:func:`networkx.algorithms.flow.preflow_push_value`) - is used. See below for alternative algorithms. + is used. See below for alternative algorithms. Default value: None. Returns ------- |