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

326 lines
16 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">
Update docs to v7.5
2020-01-27 13:48:26 +01:00
<span id="sfml">Google OR-Tools 7.5</span>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
revamp refman generation
2019-08-07 18:01:08 -07:00
<div id="content" style="width: 100%; overflow: hidden;">
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
update doc
2019-08-12 09:16:03 -07:00
<h2>C++ Reference</h2>
revamp refman generation
2019-08-07 18:01:08 -07:00
<ul>
<li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
update doc
2019-08-12 09:16:03 -07:00
<li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
revamp refman generation
2019-08-07 18:01:08 -07:00
<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>
add more C++ doc
2019-06-13 15:36:14 +02:00
<div id="content">
revamp refman generation
2019-08-07 18:01:08 -07:00
<div align="center">
<h1 style="color: #145A32;">C++ Reference: Routing</h1>
</div>
Update docs to v7.5
2020-01-27 13:48:26 +01:00
<!-- Generated by Doxygen 1.8.18 -->
add more C++ doc
2019-06-13 15:36:14 +02:00
<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>
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>
revamp refman generation
2019-08-07 18:01:08 -07:00
<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_1SimpleRevFIFO.html">SimpleRevFIFO</a></li> </ul>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
revamp refman generation
2019-08-07 18:01:08 -07:00
</div><!-- top -->
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">
revamp refman generation
2019-08-07 18:01:08 -07:00
<div class="title">SimpleRevFIFO&lt; T &gt;</div> </div>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div><!--header-->
<div class="contents">
new doc
2019-08-12 23:15:11 -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
new doc
2019-08-12 23:15:11 -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
Update docs to v7.5
2020-01-27 13:48:26 +01:00
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l00156">156</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
new doc
2019-08-12 23:15:11 -07:00
</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>
revamp refman generation
2019-08-07 18:01:08 -07:00
<tr class="memitem:adae7d9827dba5077a4e09158d8dbabcc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html#adae7d9827dba5077a4e09158d8dbabcc">SimpleRevFIFO</a> ()</td></tr>
<tr class="separator:adae7d9827dba5077a4e09158d8dbabcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac75dccd75215a324b2add603b8631ed5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html#ac75dccd75215a324b2add603b8631ed5">Push</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const s, T val)</td></tr>
<tr class="separator:ac75dccd75215a324b2add603b8631ed5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc8f4bc09139f8f3951cc8280823a0f3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html#abc8f4bc09139f8f3951cc8280823a0f3">PushIfNotTop</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const s, T val)</td></tr>
regenerate doc
2019-11-14 13:52:51 -08:00
<tr class="memdesc:abc8f4bc09139f8f3951cc8280823a0f3"><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="classoperations__research_1_1SimpleRevFIFO.html#abc8f4bc09139f8f3951cc8280823a0f3">More...</a><br /></td></tr>
revamp refman generation
2019-08-07 18:01:08 -07:00
<tr class="separator:abc8f4bc09139f8f3951cc8280823a0f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef6737cd15964935e24b68467aa4b6f1"><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#aef6737cd15964935e24b68467aa4b6f1">Last</a> () const</td></tr>
regenerate doc
2019-11-14 13:52:51 -08:00
<tr class="memdesc:aef6737cd15964935e24b68467aa4b6f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the last item of the FIFO. <a href="classoperations__research_1_1SimpleRevFIFO.html#aef6737cd15964935e24b68467aa4b6f1">More...</a><br /></td></tr>
revamp refman generation
2019-08-07 18:01:08 -07:00
<tr class="separator:aef6737cd15964935e24b68467aa4b6f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b19539e4bfd49ed8a3f8ac982068188"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html#a5b19539e4bfd49ed8a3f8ac982068188">MutableLast</a> ()</td></tr>
<tr class="separator:a5b19539e4bfd49ed8a3f8ac982068188"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae247d6af463a190ddfc1ee36eee1a880"><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#ae247d6af463a190ddfc1ee36eee1a880">LastValue</a> () const</td></tr>
regenerate doc
2019-11-14 13:52:51 -08:00
<tr class="memdesc:ae247d6af463a190ddfc1ee36eee1a880"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the last value in the FIFO. <a href="classoperations__research_1_1SimpleRevFIFO.html#ae247d6af463a190ddfc1ee36eee1a880">More...</a><br /></td></tr>
revamp refman generation
2019-08-07 18:01:08 -07:00
<tr class="separator:ae247d6af463a190ddfc1ee36eee1a880"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a374c7d46981794e6b107b12a0f3b4dea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html#a374c7d46981794e6b107b12a0f3b4dea">SetLastValue</a> (const T &amp;v)</td></tr>
regenerate doc
2019-11-14 13:52:51 -08:00
<tr class="memdesc:a374c7d46981794e6b107b12a0f3b4dea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the last value in the FIFO. <a href="classoperations__research_1_1SimpleRevFIFO.html#a374c7d46981794e6b107b12a0f3b4dea">More...</a><br /></td></tr>
revamp refman generation
2019-08-07 18:01:08 -07:00
<tr class="separator:a374c7d46981794e6b107b12a0f3b4dea"><td class="memSeparator" colspan="2">&#160;</td></tr>
add more C++ doc
2019-06-13 15:36:14 +02:00
</table>
new doc
2019-08-12 23:15:11 -07:00
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
revamp refman generation
2019-08-07 18:01:08 -07:00
<a id="adae7d9827dba5077a4e09158d8dbabcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adae7d9827dba5077a4e09158d8dbabcc">&#9670;&nbsp;</a></span>SimpleRevFIFO()</h2>
add more C++ doc
2019-06-13 15:36:14 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
revamp refman generation
2019-08-07 18:01:08 -07:00
<td class="memname"><a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">SimpleRevFIFO</a> </td>
add more C++ doc
2019-06-13 15:36:14 +02:00
<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>
revamp refman generation
2019-08-07 18:01:08 -07:00
<a id="aef6737cd15964935e24b68467aa4b6f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef6737cd15964935e24b68467aa4b6f1">&#9670;&nbsp;</a></span>Last()</h2>
add more C++ doc
2019-06-13 15:36:14 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
revamp refman generation
2019-08-07 18:01:08 -07:00
<td class="memname">const T* Last </td>
add more C++ doc
2019-06-13 15:36:14 +02:00
<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>
revamp refman generation
2019-08-07 18:01:08 -07:00
<a id="ae247d6af463a190ddfc1ee36eee1a880"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae247d6af463a190ddfc1ee36eee1a880">&#9670;&nbsp;</a></span>LastValue()</h2>
add more C++ doc
2019-06-13 15:36:14 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
revamp refman generation
2019-08-07 18:01:08 -07:00
<td class="memname">const T&amp; LastValue </td>
add more C++ doc
2019-06-13 15:36:14 +02:00
<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>
revamp refman generation
2019-08-07 18:01:08 -07:00
<a id="a5b19539e4bfd49ed8a3f8ac982068188"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b19539e4bfd49ed8a3f8ac982068188">&#9670;&nbsp;</a></span>MutableLast()</h2>
add more C++ doc
2019-06-13 15:36:14 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
revamp refman generation
2019-08-07 18:01:08 -07:00
<td class="memname">T* MutableLast </td>
add more C++ doc
2019-06-13 15:36:14 +02:00
<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>
revamp refman generation
2019-08-07 18:01:08 -07:00
<a id="ac75dccd75215a324b2add603b8631ed5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac75dccd75215a324b2add603b8631ed5">&#9670;&nbsp;</a></span>Push()</h2>
add more C++ doc
2019-06-13 15:36:14 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
revamp refman generation
2019-08-07 18:01:08 -07:00
<td class="memname">void Push </td>
add more C++ doc
2019-06-13 15:36:14 +02:00
<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>
revamp refman generation
2019-08-07 18:01:08 -07:00
<a id="abc8f4bc09139f8f3951cc8280823a0f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc8f4bc09139f8f3951cc8280823a0f3">&#9670;&nbsp;</a></span>PushIfNotTop()</h2>
add more C++ doc
2019-06-13 15:36:14 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
revamp refman generation
2019-08-07 18:01:08 -07:00
<td class="memname">void PushIfNotTop </td>
add more C++ doc
2019-06-13 15:36:14 +02:00
<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>
revamp refman generation
2019-08-07 18:01:08 -07:00
<a id="a374c7d46981794e6b107b12a0f3b4dea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a374c7d46981794e6b107b12a0f3b4dea">&#9670;&nbsp;</a></span>SetLastValue()</h2>
add more C++ doc
2019-06-13 15:36:14 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
revamp refman generation
2019-08-07 18:01:08 -07:00
<td class="memname">void SetLastValue </td>
add more C++ doc
2019-06-13 15:36:14 +02:00
<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 -->
revamp refman generation
2019-08-07 18:01:08 -07:00
</div>
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