always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
f87f82e1bfd1e005dfd90b2c43229dbd21425f85
ortools-clone/docs/cpp_routing/classoperations__research_1_1SimpleRevFIFO.html

340 lines
17 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="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>
polish cpp doc
2019-07-12 13:25:23 -07:00
</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">
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
polish cpp doc
2019-07-12 13:25:23 -07:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classoperations__research_1_1SimpleRevFIFO.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="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classoperations__research_1_1SimpleRevFIFO-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">operations_research::SimpleRevFIFO&lt; T &gt; Class 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;class T&gt;<br />
class operations_research::SimpleRevFIFO&lt; T &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>This class represent a reversible FIFO structure. </p>
<p>The main difference w.r.t a standard FIFO structure is that a <a class="el" href="classoperations__research_1_1Solver.html" title="Solver Class.">Solver</a> is given as parameter to the modifiers such that the solver can store the backtrack information <a class="el" href="classoperations__research_1_1SimpleRevFIFO_1_1Iterator.html" title="This iterator is not stable with respect to deletion.">Iterator</a>'s traversing order should not be changed, as some algorithm depend on it to be consistent. It's main use is to store a list of demons in the various classes of variables. </p>
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="constraint__solver_8h_source.html#l00150">150</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.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="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleRevFIFO_1_1Iterator.html">Iterator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This iterator is not stable with respect to deletion. <a href="classoperations__research_1_1SimpleRevFIFO_1_1Iterator.html#details">More...</a><br /></td></tr>
<tr class="separator:"><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:afe165ef59bdd847273347b78397eed2d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html#afe165ef59bdd847273347b78397eed2d">SimpleRevFIFO</a> ()</td></tr>
<tr class="separator:afe165ef59bdd847273347b78397eed2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f48d3ad864fe70677b0e3aa3e2d79e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html#a4f48d3ad864fe70677b0e3aa3e2d79e8">Push</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const s, T val)</td></tr>
<tr class="separator:a4f48d3ad864fe70677b0e3aa3e2d79e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a687b3e2756711e361d82db748ed33b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html#a8a687b3e2756711e361d82db748ed33b">PushIfNotTop</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const s, T val)</td></tr>
<tr class="memdesc:a8a687b3e2756711e361d82db748ed33b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pushes the var on top if is not a duplicate of the current top object. <a href="#a8a687b3e2756711e361d82db748ed33b">More...</a><br /></td></tr>
<tr class="separator:a8a687b3e2756711e361d82db748ed33b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd419b7fa3414e82f57ef97193948841"><td class="memItemLeft" align="right" valign="top">const T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html#acd419b7fa3414e82f57ef97193948841">Last</a> () const</td></tr>
<tr class="memdesc:acd419b7fa3414e82f57ef97193948841"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the last item of the FIFO. <a href="#acd419b7fa3414e82f57ef97193948841">More...</a><br /></td></tr>
<tr class="separator:acd419b7fa3414e82f57ef97193948841"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75bdce2821c6d39a9631e72e6851f65d"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html#a75bdce2821c6d39a9631e72e6851f65d">MutableLast</a> ()</td></tr>
<tr class="separator:a75bdce2821c6d39a9631e72e6851f65d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e4317305a0bc003c6d51548c36d69ce"><td class="memItemLeft" align="right" valign="top">const T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html#a1e4317305a0bc003c6d51548c36d69ce">LastValue</a> () const</td></tr>
<tr class="memdesc:a1e4317305a0bc003c6d51548c36d69ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the last value in the FIFO. <a href="#a1e4317305a0bc003c6d51548c36d69ce">More...</a><br /></td></tr>
<tr class="separator:a1e4317305a0bc003c6d51548c36d69ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1cd3644228ae5a0f0ec3862d91276470"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html#a1cd3644228ae5a0f0ec3862d91276470">SetLastValue</a> (const T &amp;v)</td></tr>
<tr class="memdesc:a1cd3644228ae5a0f0ec3862d91276470"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the last value in the FIFO. <a href="#a1cd3644228ae5a0f0ec3862d91276470">More...</a><br /></td></tr>
<tr class="separator:a1cd3644228ae5a0f0ec3862d91276470"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
polish cpp doc
2019-07-12 13:25:23 -07:00
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
add more C++ doc
2019-06-13 15:36:14 +02:00
<a id="afe165ef59bdd847273347b78397eed2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe165ef59bdd847273347b78397eed2d">&#9670;&nbsp;</a></span>SimpleRevFIFO()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">operations_research::SimpleRevFIFO</a>&lt; T &gt;::<a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">SimpleRevFIFO</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">
doxygen tags for the cp/routing headers; update doc; remove filter from cpp_doxy
2019-07-05 00:25:55 +02:00
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00175">175</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="acd419b7fa3414e82f57ef97193948841"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd419b7fa3414e82f57ef97193948841">&#9670;&nbsp;</a></span>Last()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const T* <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">operations_research::SimpleRevFIFO</a>&lt; T &gt;::Last </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>Returns the last item of the FIFO. </p>
doxygen tags for the cp/routing headers; update doc; remove filter from cpp_doxy
2019-07-05 00:25:55 +02:00
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00197">197</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
<a id="a1e4317305a0bc003c6d51548c36d69ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e4317305a0bc003c6d51548c36d69ce">&#9670;&nbsp;</a></span>LastValue()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const T&amp; <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">operations_research::SimpleRevFIFO</a>&lt; T &gt;::LastValue </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>Returns the last value in the FIFO. </p>
doxygen tags for the cp/routing headers; update doc; remove filter from cpp_doxy
2019-07-05 00:25:55 +02:00
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00204">204</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
<a id="a75bdce2821c6d39a9631e72e6851f65d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75bdce2821c6d39a9631e72e6851f65d">&#9670;&nbsp;</a></span>MutableLast()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">operations_research::SimpleRevFIFO</a>&lt; T &gt;::MutableLast </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">
doxygen tags for the cp/routing headers; update doc; remove filter from cpp_doxy
2019-07-05 00:25:55 +02:00
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00201">201</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
<a id="a4f48d3ad864fe70677b0e3aa3e2d79e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f48d3ad864fe70677b0e3aa3e2d79e8">&#9670;&nbsp;</a></span>Push()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">operations_research::SimpleRevFIFO</a>&lt; T &gt;::Push </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>val</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">
doxygen tags for the cp/routing headers; update doc; remove filter from cpp_doxy
2019-07-05 00:25:55 +02:00
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00177">177</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
<a id="a8a687b3e2756711e361d82db748ed33b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a687b3e2756711e361d82db748ed33b">&#9670;&nbsp;</a></span>PushIfNotTop()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">operations_research::SimpleRevFIFO</a>&lt; T &gt;::PushIfNotTop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>val</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>Pushes the var on top if is not a duplicate of the current top object. </p>
doxygen tags for the cp/routing headers; update doc; remove filter from cpp_doxy
2019-07-05 00:25:55 +02:00
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00190">190</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
<a id="a1cd3644228ae5a0f0ec3862d91276470"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1cd3644228ae5a0f0ec3862d91276470">&#9670;&nbsp;</a></span>SetLastValue()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">operations_research::SimpleRevFIFO</a>&lt; T &gt;::SetLastValue </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>v</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>Sets the last value in the FIFO. </p>
doxygen tags for the cp/routing headers; update doc; remove filter from cpp_doxy
2019-07-05 00:25:55 +02:00
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00210">210</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a></li>
<li><a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.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