Files
ortools-clone/docs/cpp_graph/structoperations__research_1_1Graphs.html
Laurent Perron 0ac3fa17eb more linear doc
2019-07-15 17:42:24 -07:00

346 lines
17 KiB
HTML

<!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>
<title>OR-Tools</title>
<meta http-equiv="Content-Type" content="text/html;"/>
<meta charset="utf-8"/>
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
<link rel="stylesheet" type="text/css" href="ortools.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">OR-Tools 7.2</span>
</div>
</div>
<link rel="icon" href="https://developers.google.com/optimization/images/orLogo.png">
<div id="content">
<!-- Generated by Doxygen 1.8.15 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structoperations__research_1_1Graphs.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="structoperations__research_1_1Graphs-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">operations_research::Graphs&lt; Graph &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Graph&gt;<br />
struct operations_research::Graphs&lt; Graph &gt;</h3>
<p>Since StarGraph does not have exactly the same interface as the other graphs, we define a correspondence there. </p>
<p class="definition">Definition at line <a class="el" href="graphs_8h_source.html#l00027">27</a> of file <a class="el" href="graphs_8h_source.html">graphs.h</a>.</p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ab48fb0d55ba8e5a1f3fae0eb20c29e2d"><td class="memItemLeft" align="right" valign="top">typedef Graph::ArcIndex&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1Graphs.html#ab48fb0d55ba8e5a1f3fae0eb20c29e2d">ArcIndex</a></td></tr>
<tr class="separator:ab48fb0d55ba8e5a1f3fae0eb20c29e2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41cd02c6876d39529d121b0f6102d3ef"><td class="memItemLeft" align="right" valign="top">typedef Graph::NodeIndex&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1Graphs.html#a41cd02c6876d39529d121b0f6102d3ef">NodeIndex</a></td></tr>
<tr class="separator:a41cd02c6876d39529d121b0f6102d3ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a9f1fe8a24918ad07513b5707f589e731"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structoperations__research_1_1Graphs.html#ab48fb0d55ba8e5a1f3fae0eb20c29e2d">ArcIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1Graphs.html#a9f1fe8a24918ad07513b5707f589e731">OppositeArc</a> (const Graph &amp;graph, <a class="el" href="structoperations__research_1_1Graphs.html#ab48fb0d55ba8e5a1f3fae0eb20c29e2d">ArcIndex</a> arc)</td></tr>
<tr class="separator:a9f1fe8a24918ad07513b5707f589e731"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66b7ad7630645132130da5a258792f4d"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1Graphs.html#a66b7ad7630645132130da5a258792f4d">IsArcValid</a> (const Graph &amp;graph, <a class="el" href="structoperations__research_1_1Graphs.html#ab48fb0d55ba8e5a1f3fae0eb20c29e2d">ArcIndex</a> arc)</td></tr>
<tr class="separator:a66b7ad7630645132130da5a258792f4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2ae542c84a1a9aa685f1e6c8e2f5503"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structoperations__research_1_1Graphs.html#a41cd02c6876d39529d121b0f6102d3ef">NodeIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1Graphs.html#ab2ae542c84a1a9aa685f1e6c8e2f5503">NodeReservation</a> (const Graph &amp;graph)</td></tr>
<tr class="separator:ab2ae542c84a1a9aa685f1e6c8e2f5503"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e2837ba11c076d455d71ff67c8ddc36"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structoperations__research_1_1Graphs.html#ab48fb0d55ba8e5a1f3fae0eb20c29e2d">ArcIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1Graphs.html#a3e2837ba11c076d455d71ff67c8ddc36">ArcReservation</a> (const Graph &amp;graph)</td></tr>
<tr class="separator:a3e2837ba11c076d455d71ff67c8ddc36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a8c52fdd8fe2db239708cb506d647e5"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1Graphs.html#a1a8c52fdd8fe2db239708cb506d647e5">Build</a> (Graph *graph)</td></tr>
<tr class="separator:a1a8c52fdd8fe2db239708cb506d647e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac47c4735096495d462403431e16f0940"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1Graphs.html#ac47c4735096495d462403431e16f0940">Build</a> (Graph *graph, std::vector&lt; <a class="el" href="structoperations__research_1_1Graphs.html#ab48fb0d55ba8e5a1f3fae0eb20c29e2d">ArcIndex</a> &gt; *permutation)</td></tr>
<tr class="separator:ac47c4735096495d462403431e16f0940"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ab48fb0d55ba8e5a1f3fae0eb20c29e2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab48fb0d55ba8e5a1f3fae0eb20c29e2d">&#9670;&nbsp;</a></span>ArcIndex</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Graph &gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef Graph::ArcIndex <a class="el" href="structoperations__research_1_1Graphs.html">operations_research::Graphs</a>&lt; Graph &gt;::<a class="el" href="structoperations__research_1_1Graphs.html#ab48fb0d55ba8e5a1f3fae0eb20c29e2d">ArcIndex</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="graphs_8h_source.html#l00028">28</a> of file <a class="el" href="graphs_8h_source.html">graphs.h</a>.</p>
</div>
</div>
<a id="a41cd02c6876d39529d121b0f6102d3ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41cd02c6876d39529d121b0f6102d3ef">&#9670;&nbsp;</a></span>NodeIndex</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Graph &gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef Graph::NodeIndex <a class="el" href="structoperations__research_1_1Graphs.html">operations_research::Graphs</a>&lt; Graph &gt;::<a class="el" href="structoperations__research_1_1Graphs.html#a41cd02c6876d39529d121b0f6102d3ef">NodeIndex</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="graphs_8h_source.html#l00029">29</a> of file <a class="el" href="graphs_8h_source.html">graphs.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3e2837ba11c076d455d71ff67c8ddc36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e2837ba11c076d455d71ff67c8ddc36">&#9670;&nbsp;</a></span>ArcReservation()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Graph &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structoperations__research_1_1Graphs.html#ab48fb0d55ba8e5a1f3fae0eb20c29e2d">ArcIndex</a> <a class="el" href="structoperations__research_1_1Graphs.html">operations_research::Graphs</a>&lt; Graph &gt;::ArcReservation </td>
<td>(</td>
<td class="paramtype">const Graph &amp;&#160;</td>
<td class="paramname"><em>graph</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="graphs_8h_source.html#l00039">39</a> of file <a class="el" href="graphs_8h_source.html">graphs.h</a>.</p>
</div>
</div>
<a id="a1a8c52fdd8fe2db239708cb506d647e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a8c52fdd8fe2db239708cb506d647e5">&#9670;&nbsp;</a></span>Build() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Graph &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="structoperations__research_1_1Graphs.html">operations_research::Graphs</a>&lt; Graph &gt;::Build </td>
<td>(</td>
<td class="paramtype">Graph *&#160;</td>
<td class="paramname"><em>graph</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="graphs_8h_source.html#l00042">42</a> of file <a class="el" href="graphs_8h_source.html">graphs.h</a>.</p>
</div>
</div>
<a id="ac47c4735096495d462403431e16f0940"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac47c4735096495d462403431e16f0940">&#9670;&nbsp;</a></span>Build() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Graph &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="structoperations__research_1_1Graphs.html">operations_research::Graphs</a>&lt; Graph &gt;::Build </td>
<td>(</td>
<td class="paramtype">Graph *&#160;</td>
<td class="paramname"><em>graph</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; <a class="el" href="structoperations__research_1_1Graphs.html#ab48fb0d55ba8e5a1f3fae0eb20c29e2d">ArcIndex</a> &gt; *&#160;</td>
<td class="paramname"><em>permutation</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="graphs_8h_source.html#l00043">43</a> of file <a class="el" href="graphs_8h_source.html">graphs.h</a>.</p>
</div>
</div>
<a id="a66b7ad7630645132130da5a258792f4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66b7ad7630645132130da5a258792f4d">&#9670;&nbsp;</a></span>IsArcValid()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Graph &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="structoperations__research_1_1Graphs.html">operations_research::Graphs</a>&lt; Graph &gt;::IsArcValid </td>
<td>(</td>
<td class="paramtype">const Graph &amp;&#160;</td>
<td class="paramname"><em>graph</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoperations__research_1_1Graphs.html#ab48fb0d55ba8e5a1f3fae0eb20c29e2d">ArcIndex</a>&#160;</td>
<td class="paramname"><em>arc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="graphs_8h_source.html#l00033">33</a> of file <a class="el" href="graphs_8h_source.html">graphs.h</a>.</p>
</div>
</div>
<a id="ab2ae542c84a1a9aa685f1e6c8e2f5503"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2ae542c84a1a9aa685f1e6c8e2f5503">&#9670;&nbsp;</a></span>NodeReservation()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Graph &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structoperations__research_1_1Graphs.html#a41cd02c6876d39529d121b0f6102d3ef">NodeIndex</a> <a class="el" href="structoperations__research_1_1Graphs.html">operations_research::Graphs</a>&lt; Graph &gt;::NodeReservation </td>
<td>(</td>
<td class="paramtype">const Graph &amp;&#160;</td>
<td class="paramname"><em>graph</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="graphs_8h_source.html#l00036">36</a> of file <a class="el" href="graphs_8h_source.html">graphs.h</a>.</p>
</div>
</div>
<a id="a9f1fe8a24918ad07513b5707f589e731"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f1fe8a24918ad07513b5707f589e731">&#9670;&nbsp;</a></span>OppositeArc()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Graph &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structoperations__research_1_1Graphs.html#ab48fb0d55ba8e5a1f3fae0eb20c29e2d">ArcIndex</a> <a class="el" href="structoperations__research_1_1Graphs.html">operations_research::Graphs</a>&lt; Graph &gt;::OppositeArc </td>
<td>(</td>
<td class="paramtype">const Graph &amp;&#160;</td>
<td class="paramname"><em>graph</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoperations__research_1_1Graphs.html#ab48fb0d55ba8e5a1f3fae0eb20c29e2d">ArcIndex</a>&#160;</td>
<td class="paramname"><em>arc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="graphs_8h_source.html#l00030">30</a> of file <a class="el" href="graphs_8h_source.html">graphs.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="graphs_8h_source.html">graphs.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>