always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
0ac3fa17eb3773cb9c00918cab3eeb2f36ae3725
ortools-clone/docs/cpp_graph/structSccCounterOutput.html

182 lines
9.3 KiB
HTML
Raw Normal View History

add more C++ doc
2019-06-13 15:36:14 +02:00
<!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"/>-->
update doc; use nice css
2019-06-20 23:08:48 +02:00
<link rel="stylesheet" type="text/css" href="ortools.css" title="default" media="screen,print" />
add more C++ doc
2019-06-13 15:36:14 +02:00
<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">
bump version to 7.2; regenerate doc
2019-06-29 18:18:08 +02:00
<span id="sfml">OR-Tools 7.2</span>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
bump version to 7.2; regenerate doc
2019-06-29 18:18:08 +02:00
<link rel="icon" href="https://developers.google.com/optimization/images/orLogo.png">
add more C++ doc
2019-06-13 15:36:14 +02:00
<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>
more linear doc
2019-07-15 17:42:24 -07:00
<li><a href="files.html"><span>Files</span></a></li>
add more C++ doc
2019-06-13 15:36:14 +02:00
</ul>
</div>
</div><!-- top -->
polish cpp doc
2019-07-12 13:25:23 -07:00
<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('structSccCounterOutput.html','');});
/* @license-end */
</script>
<div id="doc-content">
add more C++ doc
2019-06-13 15:36:14 +02:00
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structSccCounterOutput-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SccCounterOutput&lt; NodeIndex &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
polish cpp doc
2019-07-12 13:25:23 -07:00
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename NodeIndex&gt;<br />
struct SccCounterOutput&lt; NodeIndex &gt;</h3>
add more C++ doc
2019-06-13 15:36:14 +02:00
polish cpp doc
2019-07-12 13:25:23 -07:00
<p>A simple custom output class that just counts the number of SCC. </p>
<p>Not allocating many vectors can save both space and speed if your graph is large.</p>
<dl class="section note"><dt>Note</dt><dd>If this matters, you probably don't want to use std::vector&lt;std::vector&lt;int&gt;&gt; as an input either. See StaticGraph in <a class="el" href="graph_8h.html">ortools/graph/graph.h</a> for an efficient graph data structure compatible with this algorithm. </dd></dl>
add more C++ doc
2019-06-13 15:36:14 +02:00
polish cpp doc
2019-07-12 13:25:23 -07:00
<p class="definition">Definition at line <a class="el" href="strongly__connected__components_8h_source.html#l00083">83</a> of file <a class="el" href="strongly__connected__components_8h_source.html">strongly_connected_components.h</a>.</p>
</div><table class="memberdecls">
add more C++ doc
2019-06-13 15:36:14 +02:00
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a98b2cfdab0fa5812eec11b4a5e85bf05"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSccCounterOutput.html#a98b2cfdab0fa5812eec11b4a5e85bf05">emplace_back</a> (NodeIndex const *b, NodeIndex const *e)</td></tr>
<tr class="separator:a98b2cfdab0fa5812eec11b4a5e85bf05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31eef251d309df342e2dd150389e2458"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSccCounterOutput.html#a31eef251d309df342e2dd150389e2458">size</a> () const</td></tr>
<tr class="memdesc:a31eef251d309df342e2dd150389e2458"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is just here so this class can transparently replace a code that use std::vector&lt;std::vector&lt;int&gt;&gt; as an SccOutput, and get its size with <a class="el" href="structSccCounterOutput.html#a31eef251d309df342e2dd150389e2458" title="This is just here so this class can transparently replace a code that use std::vector&lt;std::vector&lt;int...">size()</a>. <a href="#a31eef251d309df342e2dd150389e2458">More...</a><br /></td></tr>
<tr class="separator:a31eef251d309df342e2dd150389e2458"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aa506bc8bf4c4be4615a22a7d1d1d1662"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSccCounterOutput.html#aa506bc8bf4c4be4615a22a7d1d1d1662">number_of_components</a> = 0</td></tr>
<tr class="separator:aa506bc8bf4c4be4615a22a7d1d1d1662"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
polish cpp doc
2019-07-12 13:25:23 -07:00
<h2 class="groupheader">Member Function Documentation</h2>
add more C++ doc
2019-06-13 15:36:14 +02:00
<a id="a98b2cfdab0fa5812eec11b4a5e85bf05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98b2cfdab0fa5812eec11b4a5e85bf05">&#9670;&nbsp;</a></span>emplace_back()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename NodeIndex &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structSccCounterOutput.html">SccCounterOutput</a>&lt; NodeIndex &gt;::emplace_back </td>
<td>(</td>
<td class="paramtype">NodeIndex const *&#160;</td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">NodeIndex const *&#160;</td>
<td class="paramname"><em>e</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="strongly__connected__components_8h_source.html#l00085">85</a> of file <a class="el" href="strongly__connected__components_8h_source.html">strongly_connected_components.h</a>.</p>
</div>
</div>
<a id="a31eef251d309df342e2dd150389e2458"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31eef251d309df342e2dd150389e2458">&#9670;&nbsp;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename NodeIndex &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structSccCounterOutput.html">SccCounterOutput</a>&lt; NodeIndex &gt;::size </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>This is just here so this class can transparently replace a code that use std::vector&lt;std::vector&lt;int&gt;&gt; as an SccOutput, and get its size with <a class="el" href="structSccCounterOutput.html#a31eef251d309df342e2dd150389e2458" title="This is just here so this class can transparently replace a code that use std::vector&lt;std::vector&lt;int...">size()</a>. </p>
<p class="definition">Definition at line <a class="el" href="strongly__connected__components_8h_source.html#l00091">91</a> of file <a class="el" href="strongly__connected__components_8h_source.html">strongly_connected_components.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa506bc8bf4c4be4615a22a7d1d1d1662"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa506bc8bf4c4be4615a22a7d1d1d1662">&#9670;&nbsp;</a></span>number_of_components</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename NodeIndex &gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structSccCounterOutput.html">SccCounterOutput</a>&lt; NodeIndex &gt;::number_of_components = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="strongly__connected__components_8h_source.html#l00084">84</a> of file <a class="el" href="strongly__connected__components_8h_source.html">strongly_connected_components.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="strongly__connected__components_8h_source.html">strongly_connected_components.h</a></li>
</ul>
</div><!-- contents -->
polish cpp doc
2019-07-12 13:25:23 -07:00
</div><!-- doc-content -->
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink