Files
ortools-clone/docs/cpp_graph/structoperations__research_1_1Graphs.html
Corentin Le Molgat b670dc9daa Update doc
2020-04-23 15:34:43 +02:00

328 lines
16 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">Google OR-Tools 7.5</span>
</div>
</div>
<div id="content" style="width: 100%; overflow: hidden;">
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
<h2>C++ Reference</h2>
<ul>
<li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
<li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
<li><a href="../cpp_graph/annotated.html">Graph</a></li>
<li><a href="../cpp_routing/annotated.html">Routing</a></li>
<li><a href="../cpp_linear/annotated.html">Linear solver</a></li>
</ul>
</div>
<div id="content">
<div align="center">
<h1 style="color: #145A32;">C++ Reference: Graph</h1>
</div>
<!-- Generated by Doxygen 1.8.16 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceoperations__research.html">operations_research</a></li><li class="navelem"><a class="el" href="structoperations__research_1_1Graphs.html">Graphs</a></li> </ul>
</div>
</div><!-- top -->
<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">Graphs&lt; Graph &gt;</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 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:a44aa9e2f47277c91d8064c7126a2ff48"><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#a44aa9e2f47277c91d8064c7126a2ff48">ArcIndex</a></td></tr>
<tr class="separator:a44aa9e2f47277c91d8064c7126a2ff48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ddaeee9414a17257bb052c459325caf"><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#a4ddaeee9414a17257bb052c459325caf">NodeIndex</a></td></tr>
<tr class="separator:a4ddaeee9414a17257bb052c459325caf"><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:ae9cc106c6139c0b4e57057594bf56ea8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structoperations__research_1_1Graphs.html#a44aa9e2f47277c91d8064c7126a2ff48">ArcIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1Graphs.html#ae9cc106c6139c0b4e57057594bf56ea8">OppositeArc</a> (const Graph &amp;graph, <a class="el" href="structoperations__research_1_1Graphs.html#a44aa9e2f47277c91d8064c7126a2ff48">ArcIndex</a> arc)</td></tr>
<tr class="separator:ae9cc106c6139c0b4e57057594bf56ea8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae02cd8602383e4fb48a8a933325db5fd"><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#ae02cd8602383e4fb48a8a933325db5fd">IsArcValid</a> (const Graph &amp;graph, <a class="el" href="structoperations__research_1_1Graphs.html#a44aa9e2f47277c91d8064c7126a2ff48">ArcIndex</a> arc)</td></tr>
<tr class="separator:ae02cd8602383e4fb48a8a933325db5fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d530d16efbea1a29d61cb0325980a50"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structoperations__research_1_1Graphs.html#a4ddaeee9414a17257bb052c459325caf">NodeIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1Graphs.html#a9d530d16efbea1a29d61cb0325980a50">NodeReservation</a> (const Graph &amp;graph)</td></tr>
<tr class="separator:a9d530d16efbea1a29d61cb0325980a50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42fb6857e088a176a53232b910715260"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structoperations__research_1_1Graphs.html#a44aa9e2f47277c91d8064c7126a2ff48">ArcIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1Graphs.html#a42fb6857e088a176a53232b910715260">ArcReservation</a> (const Graph &amp;graph)</td></tr>
<tr class="separator:a42fb6857e088a176a53232b910715260"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4012242a9e38a525508c059fcfb5067c"><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#a4012242a9e38a525508c059fcfb5067c">Build</a> (Graph *graph)</td></tr>
<tr class="separator:a4012242a9e38a525508c059fcfb5067c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab984d754556724f92363ea83c776d45b"><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#ab984d754556724f92363ea83c776d45b">Build</a> (Graph *graph, std::vector&lt; <a class="el" href="structoperations__research_1_1Graphs.html#a44aa9e2f47277c91d8064c7126a2ff48">ArcIndex</a> &gt; *permutation)</td></tr>
<tr class="separator:ab984d754556724f92363ea83c776d45b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a44aa9e2f47277c91d8064c7126a2ff48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44aa9e2f47277c91d8064c7126a2ff48">&#9670;&nbsp;</a></span>ArcIndex</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Graph::ArcIndex <a class="el" href="structoperations__research_1_1Graphs.html#a44aa9e2f47277c91d8064c7126a2ff48">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="a4ddaeee9414a17257bb052c459325caf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ddaeee9414a17257bb052c459325caf">&#9670;&nbsp;</a></span>NodeIndex</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Graph::NodeIndex <a class="el" href="structoperations__research_1_1Graphs.html#a4ddaeee9414a17257bb052c459325caf">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="a42fb6857e088a176a53232b910715260"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42fb6857e088a176a53232b910715260">&#9670;&nbsp;</a></span>ArcReservation()</h2>
<div class="memitem">
<div class="memproto">
<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#a44aa9e2f47277c91d8064c7126a2ff48">ArcIndex</a> 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="a4012242a9e38a525508c059fcfb5067c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4012242a9e38a525508c059fcfb5067c">&#9670;&nbsp;</a></span>Build() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void 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="ab984d754556724f92363ea83c776d45b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab984d754556724f92363ea83c776d45b">&#9670;&nbsp;</a></span>Build() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void 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#a44aa9e2f47277c91d8064c7126a2ff48">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="ae02cd8602383e4fb48a8a933325db5fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae02cd8602383e4fb48a8a933325db5fd">&#9670;&nbsp;</a></span>IsArcValid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool 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#a44aa9e2f47277c91d8064c7126a2ff48">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="a9d530d16efbea1a29d61cb0325980a50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d530d16efbea1a29d61cb0325980a50">&#9670;&nbsp;</a></span>NodeReservation()</h2>
<div class="memitem">
<div class="memproto">
<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#a4ddaeee9414a17257bb052c459325caf">NodeIndex</a> 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="ae9cc106c6139c0b4e57057594bf56ea8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9cc106c6139c0b4e57057594bf56ea8">&#9670;&nbsp;</a></span>OppositeArc()</h2>
<div class="memitem">
<div class="memproto">
<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#a44aa9e2f47277c91d8064c7126a2ff48">ArcIndex</a> 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#a44aa9e2f47277c91d8064c7126a2ff48">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>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>