always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
148f14ffa0932e059a138096d7eec04d1bb463cc
ortools-clone/docs/cpp_graph/classoperations__research_1_1SetRangeIterator.html
Laurent Perron 4110709d1c separate c++ doc by module
2019-06-13 15:51:12 +02:00

262 lines
15 KiB
HTML
Raw Blame History

<!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="doxygen.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.1@</span>
</div>
</div>
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</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="classoperations__research_1_1SetRangeIterator.html">SetRangeIterator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classoperations__research_1_1SetRangeIterator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">operations_research::SetRangeIterator&lt; SetRange &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An iterator for sets of increasing corresponding values that have the same cardinality.
<a href="classoperations__research_1_1SetRangeIterator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="hamiltonian__path_8h_source.html">hamiltonian_path.h</a>&gt;</code></p>
<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:ac33a8fa2bd3858cb38ac4aa7027b14f3"><td class="memItemLeft" align="right" valign="top">typedef SetRange::SetType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SetRangeIterator.html#ac33a8fa2bd3858cb38ac4aa7027b14f3">SetType</a></td></tr>
<tr class="memdesc:ac33a8fa2bd3858cb38ac4aa7027b14f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make the parameter types visible to <a class="el" href="classoperations__research_1_1SetRangeWithCardinality.html">SetRangeWithCardinality</a>. <a href="#ac33a8fa2bd3858cb38ac4aa7027b14f3">More...</a><br /></td></tr>
<tr class="separator:ac33a8fa2bd3858cb38ac4aa7027b14f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b736bbe536c9abc15d84d5fa462a506"><td class="memItemLeft" align="right" valign="top">typedef SetType::IntegerType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SetRangeIterator.html#a8b736bbe536c9abc15d84d5fa462a506">IntegerType</a></td></tr>
<tr class="separator:a8b736bbe536c9abc15d84d5fa462a506"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:ab10604e513e69c2e69885026aa4419f6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SetRangeIterator.html#ab10604e513e69c2e69885026aa4419f6">SetRangeIterator</a> (const <a class="el" href="classoperations__research_1_1SetRangeIterator.html#ac33a8fa2bd3858cb38ac4aa7027b14f3">SetType</a> set)</td></tr>
<tr class="separator:ab10604e513e69c2e69885026aa4419f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91417bb16ed420eba66eeb88cad385a9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoperations__research_1_1SetRangeIterator.html#ac33a8fa2bd3858cb38ac4aa7027b14f3">SetType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SetRangeIterator.html#a91417bb16ed420eba66eeb88cad385a9">operator *</a> () const</td></tr>
<tr class="memdesc:a91417bb16ed420eba66eeb88cad385a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">STL iterator-related methods. <a href="#a91417bb16ed420eba66eeb88cad385a9">More...</a><br /></td></tr>
<tr class="separator:a91417bb16ed420eba66eeb88cad385a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae49d2a420e45ad8370e29906e66572ee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SetRangeIterator.html#ae49d2a420e45ad8370e29906e66572ee">operator!=</a> (const <a class="el" href="classoperations__research_1_1SetRangeIterator.html">SetRangeIterator</a> &amp;other) const</td></tr>
<tr class="separator:ae49d2a420e45ad8370e29906e66572ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b617b0eee1cb874ce18d0fbfbcb0857"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classoperations__research_1_1SetRangeIterator.html">SetRangeIterator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SetRangeIterator.html#a2b617b0eee1cb874ce18d0fbfbcb0857">operator++</a> ()</td></tr>
<tr class="memdesc:a2b617b0eee1cb874ce18d0fbfbcb0857"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the next set with the same cardinality using Gosper's hack. <a href="#a2b617b0eee1cb874ce18d0fbfbcb0857">More...</a><br /></td></tr>
<tr class="separator:a2b617b0eee1cb874ce18d0fbfbcb0857"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename SetRange&gt;<br />
class operations_research::SetRangeIterator&lt; SetRange &gt;</h3>
<p>An iterator for sets of increasing corresponding values that have the same cardinality. </p>
<p>For example, the sets with cardinality 3 will be listed as ...00111, ...01011, ...01101, ...1110, etc... </p>
<p class="definition">Definition at line <a class="el" href="hamiltonian__path_8h_source.html#l00223">223</a> of file <a class="el" href="hamiltonian__path_8h_source.html">hamiltonian_path.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a8b736bbe536c9abc15d84d5fa462a506"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b736bbe536c9abc15d84d5fa462a506">&#9670;&nbsp;</a></span>IntegerType</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SetRange &gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef SetType::IntegerType <a class="el" href="classoperations__research_1_1SetRangeIterator.html">operations_research::SetRangeIterator</a>&lt; SetRange &gt;::<a class="el" href="classoperations__research_1_1SetRangeIterator.html#a8b736bbe536c9abc15d84d5fa462a506">IntegerType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hamiltonian__path_8h_source.html#l00227">227</a> of file <a class="el" href="hamiltonian__path_8h_source.html">hamiltonian_path.h</a>.</p>
</div>
</div>
<a id="ac33a8fa2bd3858cb38ac4aa7027b14f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac33a8fa2bd3858cb38ac4aa7027b14f3">&#9670;&nbsp;</a></span>SetType</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SetRange &gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef SetRange::SetType <a class="el" href="classoperations__research_1_1SetRangeIterator.html">operations_research::SetRangeIterator</a>&lt; SetRange &gt;::<a class="el" href="classoperations__research_1_1SetRangeIterator.html#ac33a8fa2bd3858cb38ac4aa7027b14f3">SetType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Make the parameter types visible to <a class="el" href="classoperations__research_1_1SetRangeWithCardinality.html">SetRangeWithCardinality</a>. </p>
<p class="definition">Definition at line <a class="el" href="hamiltonian__path_8h_source.html#l00226">226</a> of file <a class="el" href="hamiltonian__path_8h_source.html">hamiltonian_path.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab10604e513e69c2e69885026aa4419f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab10604e513e69c2e69885026aa4419f6">&#9670;&nbsp;</a></span>SetRangeIterator()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SetRange &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1SetRangeIterator.html">operations_research::SetRangeIterator</a>&lt; SetRange &gt;::<a class="el" href="classoperations__research_1_1SetRangeIterator.html">SetRangeIterator</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classoperations__research_1_1SetRangeIterator.html#ac33a8fa2bd3858cb38ac4aa7027b14f3">SetType</a>&#160;</td>
<td class="paramname"><em>set</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hamiltonian__path_8h_source.html#l00229">229</a> of file <a class="el" href="hamiltonian__path_8h_source.html">hamiltonian_path.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a91417bb16ed420eba66eeb88cad385a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91417bb16ed420eba66eeb88cad385a9">&#9670;&nbsp;</a></span>operator *()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SetRange &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1SetRangeIterator.html#ac33a8fa2bd3858cb38ac4aa7027b14f3">SetType</a> <a class="el" href="classoperations__research_1_1SetRangeIterator.html">operations_research::SetRangeIterator</a>&lt; SetRange &gt;::operator * </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>STL iterator-related methods. </p>
<p class="definition">Definition at line <a class="el" href="hamiltonian__path_8h_source.html#l00232">232</a> of file <a class="el" href="hamiltonian__path_8h_source.html">hamiltonian_path.h</a>.</p>
</div>
</div>
<a id="ae49d2a420e45ad8370e29906e66572ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae49d2a420e45ad8370e29906e66572ee">&#9670;&nbsp;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SetRange &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classoperations__research_1_1SetRangeIterator.html">operations_research::SetRangeIterator</a>&lt; SetRange &gt;::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classoperations__research_1_1SetRangeIterator.html">SetRangeIterator</a>&lt; SetRange &gt; &amp;&#160;</td>
<td class="paramname"><em>other</em></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="hamiltonian__path_8h_source.html#l00233">233</a> of file <a class="el" href="hamiltonian__path_8h_source.html">hamiltonian_path.h</a>.</p>
</div>
</div>
<a id="a2b617b0eee1cb874ce18d0fbfbcb0857"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b617b0eee1cb874ce18d0fbfbcb0857">&#9670;&nbsp;</a></span>operator++()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SetRange &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classoperations__research_1_1SetRangeIterator.html">SetRangeIterator</a>&amp; <a class="el" href="classoperations__research_1_1SetRangeIterator.html">operations_research::SetRangeIterator</a>&lt; SetRange &gt;::operator++ </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>Computes the next set with the same cardinality using Gosper's hack. </p>
<p><a href="ftp://publications.ai.mit.edu/ai-publications/pdf/AIM-239.pdf">ftp://publications.ai.mit.edu/ai-publications/pdf/AIM-239.pdf</a> ITEM 175 Also translated in C <a href="https://www.cl.cam.ac.uk/~am21/hakmemc.html">https://www.cl.cam.ac.uk/~am21/hakmemc.html</a> </p>
<p>Dividing by c as in HAKMEMC can be avoided by taking into account that c is the smallest singleton of current_set_, and using a shift. </p>
<p class="definition">Definition at line <a class="el" href="hamiltonian__path_8h_source.html#l00240">240</a> of file <a class="el" href="hamiltonian__path_8h_source.html">hamiltonian_path.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="hamiltonian__path_8h_source.html">hamiltonian_path.h</a></li>
</ul>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink