Files
ortools-clone/docs/cpp_graph/class_connected_components_finder.html
2021-01-26 11:34:47 +01:00

456 lines
20 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"/>-->
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="styleSheet.tmp.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">Google OR-Tools 8.2</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.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></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('class_connected_components_finder.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_connected_components_finder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ConnectedComponentsFinder&lt; T, CompareOrHashT &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 T, typename CompareOrHashT = std::less&lt;T&gt;&gt;<br />
class ConnectedComponentsFinder&lt; T, CompareOrHashT &gt;</h3>
<p class="definition">Definition at line <a class="el" href="connected__components_8h_source.html#l00198">198</a> of file <a class="el" href="connected__components_8h_source.html">connected_components.h</a>.</p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9d3b69f74c9aa5e8ddbf4e4056320a66"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connected_components_finder.html#a9d3b69f74c9aa5e8ddbf4e4056320a66">ConnectedComponentsFinder</a> ()</td></tr>
<tr class="separator:a9d3b69f74c9aa5e8ddbf4e4056320a66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa734f643cbf03341560a258b421414e7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connected_components_finder.html#aa734f643cbf03341560a258b421414e7">ConnectedComponentsFinder</a> (const <a class="el" href="class_connected_components_finder.html">ConnectedComponentsFinder</a> &amp;)=delete</td></tr>
<tr class="separator:aa734f643cbf03341560a258b421414e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afab44a2f4671e0d0b0f30268ee17b70a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_connected_components_finder.html">ConnectedComponentsFinder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connected_components_finder.html#afab44a2f4671e0d0b0f30268ee17b70a">operator=</a> (const <a class="el" href="class_connected_components_finder.html">ConnectedComponentsFinder</a> &amp;)=delete</td></tr>
<tr class="separator:afab44a2f4671e0d0b0f30268ee17b70a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ad4abab1ba8325ac397efcba89563d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connected_components_finder.html#a5ad4abab1ba8325ac397efcba89563d4">AddNode</a> (T node)</td></tr>
<tr class="separator:a5ad4abab1ba8325ac397efcba89563d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e071f70e8c79a30a74cba46917630ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connected_components_finder.html#a3e071f70e8c79a30a74cba46917630ec">AddEdge</a> (T node1, T node2)</td></tr>
<tr class="separator:a3e071f70e8c79a30a74cba46917630ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7782f36c09257f370347166e02480f1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connected_components_finder.html#ac7782f36c09257f370347166e02480f1">Connected</a> (T node1, T node2)</td></tr>
<tr class="separator:ac7782f36c09257f370347166e02480f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c22d56c6bcad754b70f626de84070a0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connected_components_finder.html#a8c22d56c6bcad754b70f626de84070a0">GetSize</a> (T node)</td></tr>
<tr class="separator:a8c22d56c6bcad754b70f626de84070a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1ba612c449ee127c1e747851c56a5fd"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::vector&lt; T &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connected_components_finder.html#aa1ba612c449ee127c1e747851c56a5fd">FindConnectedComponents</a> ()</td></tr>
<tr class="separator:aa1ba612c449ee127c1e747851c56a5fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0d3efb0bf815ede0da31097a11c4a27"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connected_components_finder.html#ac0d3efb0bf815ede0da31097a11c4a27">FindConnectedComponents</a> (std::vector&lt; typename <a class="el" href="structinternal_1_1_connected_components_type_helper.html">internal::ConnectedComponentsTypeHelper</a>&lt; T, CompareOrHashT &gt;::Set &gt; *components)</td></tr>
<tr class="separator:ac0d3efb0bf815ede0da31097a11c4a27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1a300e659dbc3041b1485f12855bd31"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connected_components_finder.html#af1a300e659dbc3041b1485f12855bd31">GetNumberOfComponents</a> () const</td></tr>
<tr class="separator:af1a300e659dbc3041b1485f12855bd31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeeb8b88902830cab41c69ef944b5694f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connected_components_finder.html#aeeb8b88902830cab41c69ef944b5694f">GetNumberOfNodes</a> () const</td></tr>
<tr class="separator:aeeb8b88902830cab41c69ef944b5694f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9d3b69f74c9aa5e8ddbf4e4056320a66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d3b69f74c9aa5e8ddbf4e4056320a66">&#9670;&nbsp;</a></span>ConnectedComponentsFinder() <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"><a class="el" href="class_connected_components_finder.html">ConnectedComponentsFinder</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="connected__components_8h_source.html#l00201">201</a> of file <a class="el" href="connected__components_8h_source.html">connected_components.h</a>.</p>
</div>
</div>
<a id="aa734f643cbf03341560a258b421414e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa734f643cbf03341560a258b421414e7">&#9670;&nbsp;</a></span>ConnectedComponentsFinder() <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"><a class="el" href="class_connected_components_finder.html">ConnectedComponentsFinder</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_connected_components_finder.html">ConnectedComponentsFinder</a>&lt; T, CompareOrHashT &gt; &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3e071f70e8c79a30a74cba46917630ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e071f70e8c79a30a74cba46917630ec">&#9670;&nbsp;</a></span>AddEdge()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AddEdge </td>
<td>(</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>node1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>node2</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="connected__components_8h_source.html#l00213">213</a> of file <a class="el" href="connected__components_8h_source.html">connected_components.h</a>.</p>
</div>
</div>
<a id="a5ad4abab1ba8325ac397efcba89563d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ad4abab1ba8325ac397efcba89563d4">&#9670;&nbsp;</a></span>AddNode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AddNode </td>
<td>(</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>node</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="connected__components_8h_source.html#l00209">209</a> of file <a class="el" href="connected__components_8h_source.html">connected_components.h</a>.</p>
</div>
</div>
<a id="ac7782f36c09257f370347166e02480f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7782f36c09257f370347166e02480f1">&#9670;&nbsp;</a></span>Connected()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Connected </td>
<td>(</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>node1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>node2</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="connected__components_8h_source.html#l00220">220</a> of file <a class="el" href="connected__components_8h_source.html">connected_components.h</a>.</p>
</div>
</div>
<a id="aa1ba612c449ee127c1e747851c56a5fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1ba612c449ee127c1e747851c56a5fd">&#9670;&nbsp;</a></span>FindConnectedComponents() <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">std::vector&lt;std::vector&lt;T&gt; &gt; FindConnectedComponents </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="connected__components_8h_source.html#l00241">241</a> of file <a class="el" href="connected__components_8h_source.html">connected_components.h</a>.</p>
</div>
</div>
<a id="ac0d3efb0bf815ede0da31097a11c4a27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0d3efb0bf815ede0da31097a11c4a27">&#9670;&nbsp;</a></span>FindConnectedComponents() <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">void FindConnectedComponents </td>
<td>(</td>
<td class="paramtype">std::vector&lt; typename <a class="el" href="structinternal_1_1_connected_components_type_helper.html">internal::ConnectedComponentsTypeHelper</a>&lt; T, CompareOrHashT &gt;::Set &gt; *&#160;</td>
<td class="paramname"><em>components</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="connected__components_8h_source.html#l00249">249</a> of file <a class="el" href="connected__components_8h_source.html">connected_components.h</a>.</p>
</div>
</div>
<a id="af1a300e659dbc3041b1485f12855bd31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1a300e659dbc3041b1485f12855bd31">&#9670;&nbsp;</a></span>GetNumberOfComponents()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int GetNumberOfComponents </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="connected__components_8h_source.html#l00262">262</a> of file <a class="el" href="connected__components_8h_source.html">connected_components.h</a>.</p>
</div>
</div>
<a id="aeeb8b88902830cab41c69ef944b5694f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeeb8b88902830cab41c69ef944b5694f">&#9670;&nbsp;</a></span>GetNumberOfNodes()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int GetNumberOfNodes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="connected__components_8h_source.html#l00270">270</a> of file <a class="el" href="connected__components_8h_source.html">connected_components.h</a>.</p>
</div>
</div>
<a id="a8c22d56c6bcad754b70f626de84070a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c22d56c6bcad754b70f626de84070a0">&#9670;&nbsp;</a></span>GetSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int GetSize </td>
<td>(</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>node</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="connected__components_8h_source.html#l00228">228</a> of file <a class="el" href="connected__components_8h_source.html">connected_components.h</a>.</p>
</div>
</div>
<a id="afab44a2f4671e0d0b0f30268ee17b70a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afab44a2f4671e0d0b0f30268ee17b70a">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_connected_components_finder.html">ConnectedComponentsFinder</a>&amp; operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_connected_components_finder.html">ConnectedComponentsFinder</a>&lt; T, CompareOrHashT &gt; &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="connected__components_8h_source.html">connected_components.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>