<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>cost_of_flow — NetworkX 1.8.1 documentation</title>
<link rel="stylesheet" href="../../_static/networkx.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.8.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: false
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within NetworkX 1.8.1 documentation"
href="../../_static/opensearch.xml"/>
<link rel="top" title="NetworkX 1.8.1 documentation" href="../../index.html" />
<link rel="up" title="Flows" href="../algorithms.flow.html" />
<link rel="next" title="max_flow_min_cost" href="networkx.algorithms.flow.max_flow_min_cost.html" />
<link rel="prev" title="min_cost_flow" href="networkx.algorithms.flow.min_cost_flow.html" />
</head>
<body>
<div style="color: black;background-color: white; font-size: 3.2em; text-align: left; padding: 15px 10px 10px 15px">
NetworkX
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="networkx.algorithms.flow.max_flow_min_cost.html" title="max_flow_min_cost"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="networkx.algorithms.flow.min_cost_flow.html" title="min_cost_flow"
accesskey="P">previous</a> |</li>
<li><a href="http://networkx.github.com/">NetworkX Home </a> | </li>
<li><a href="http://networkx.github.com/documentation.html">Documentation </a>| </li>
<li><a href="http://networkx.github.com/download.html">Download </a> | </li>
<li><a href="http://github.com/networkx">Developer (Github)</a></li>
<li><a href="../index.html" >Reference</a> »</li>
<li><a href="../pdf_reference.html" >Reference</a> »</li>
<li><a href="../algorithms.html" >Algorithms</a> »</li>
<li><a href="../algorithms.flow.html" accesskey="U">Flows</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="networkx.algorithms.flow.min_cost_flow.html"
title="previous chapter">min_cost_flow</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="networkx.algorithms.flow.max_flow_min_cost.html"
title="next chapter">max_flow_min_cost</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="cost-of-flow">
<h1>cost_of_flow<a class="headerlink" href="#cost-of-flow" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="networkx.algorithms.flow.cost_of_flow">
<tt class="descname">cost_of_flow</tt><big>(</big><em>G</em>, <em>flowDict</em>, <em>weight='weight'</em><big>)</big><a class="headerlink" href="#networkx.algorithms.flow.cost_of_flow" title="Permalink to this definition">¶</a></dt>
<dd><p>Compute the cost of the flow given by flowDict on graph G.</p>
<p>Note that this function does not check for the validity of the
flow flowDict. This function will fail if the graph G and the
flow don’t have the same edge set.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters :</th><td class="field-body"><p class="first"><strong>G</strong> : NetworkX graph</p>
<blockquote>
<div><p>DiGraph on which a minimum cost flow satisfying all demands is
to be found.</p>
</div></blockquote>
<p><strong>weight: string</strong> :</p>
<blockquote>
<div><p>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’.</p>
</div></blockquote>
<p><strong>flowDict: dictionary</strong> :</p>
<blockquote>
<div><p>Dictionary of dictionaries keyed by nodes such that
flowDict[u][v] is the flow edge (u, v).</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns :</th><td class="field-body"><p class="first"><strong>cost: Integer, float</strong> :</p>
<blockquote class="last">
<div><p>The total cost of the flow. This is given by the sum over all
edges of the product of the edge’s flow and the edge’s weight.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="networkx.algorithms.flow.max_flow_min_cost.html#networkx.algorithms.flow.max_flow_min_cost" title="networkx.algorithms.flow.max_flow_min_cost"><tt class="xref py py-obj docutils literal"><span class="pre">max_flow_min_cost</span></tt></a>, <a class="reference internal" href="networkx.algorithms.flow.min_cost_flow.html#networkx.algorithms.flow.min_cost_flow" title="networkx.algorithms.flow.min_cost_flow"><tt class="xref py py-obj docutils literal"><span class="pre">min_cost_flow</span></tt></a>, <a class="reference internal" href="networkx.algorithms.flow.min_cost_flow_cost.html#networkx.algorithms.flow.min_cost_flow_cost" title="networkx.algorithms.flow.min_cost_flow_cost"><tt class="xref py py-obj docutils literal"><span class="pre">min_cost_flow_cost</span></tt></a>, <a class="reference internal" href="networkx.algorithms.flow.network_simplex.html#networkx.algorithms.flow.network_simplex" title="networkx.algorithms.flow.network_simplex"><tt class="xref py py-obj docutils literal"><span class="pre">network_simplex</span></tt></a></p>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="networkx.algorithms.flow.max_flow_min_cost.html" title="max_flow_min_cost"
>next</a> |</li>
<li class="right" >
<a href="networkx.algorithms.flow.min_cost_flow.html" title="min_cost_flow"
>previous</a> |</li>
<li><a href="http://networkx.github.com/">NetworkX Home </a> | </li>
<li><a href="http://networkx.github.com/documentation.html">Documentation </a>| </li>
<li><a href="http://networkx.github.com/download.html">Download </a> | </li>
<li><a href="http://github.com/networkx">Developer (Github)</a></li>
<li><a href="../index.html" >Reference</a> »</li>
<li><a href="../pdf_reference.html" >Reference</a> »</li>
<li><a href="../algorithms.html" >Algorithms</a> »</li>
<li><a href="../algorithms.flow.html" >Flows</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, NetworkX Developers.
Last updated on Oct 23, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
