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

312 lines
15 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>
<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_1RevImmutableMultiMap.html">RevImmutableMultiMap</a></li> </ul>
</div>
</div><!-- top -->
<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_1RevImmutableMultiMap-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">operations_research::RevImmutableMultiMap&lt; K, V &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>--&mdash; Immutable Multi Map --&mdash;
<a href="classoperations__research_1_1RevImmutableMultiMap.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>&gt;</code></p>
<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:afbd7546d603df82059ed3b8a13a3241a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html#afbd7546d603df82059ed3b8a13a3241a">RevImmutableMultiMap</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const <a class="el" href="routing_8h.html#a5f32c22c620c811754ba7b6f977db864">solver</a>, int initial_size)</td></tr>
<tr class="separator:afbd7546d603df82059ed3b8a13a3241a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8f8619f77a20868de764b036066dc3b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html#af8f8619f77a20868de764b036066dc3b">~RevImmutableMultiMap</a> ()</td></tr>
<tr class="separator:af8f8619f77a20868de764b036066dc3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae509969cf05f560f829ce4e0ed3aab1c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html#ae509969cf05f560f829ce4e0ed3aab1c">num_items</a> () const</td></tr>
<tr class="separator:ae509969cf05f560f829ce4e0ed3aab1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55a49c7e6673d8ec5a30b3255899a23a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html#a55a49c7e6673d8ec5a30b3255899a23a">ContainsKey</a> (const K &amp;key) const</td></tr>
<tr class="memdesc:a55a49c7e6673d8ec5a30b3255899a23a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the multi-map contains at least one instance of 'key'. <a href="#a55a49c7e6673d8ec5a30b3255899a23a">More...</a><br /></td></tr>
<tr class="separator:a55a49c7e6673d8ec5a30b3255899a23a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84ccc9de1e12d064f1ccf77e344dd86b"><td class="memItemLeft" align="right" valign="top">const V &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html#a84ccc9de1e12d064f1ccf77e344dd86b">FindWithDefault</a> (const K &amp;key, const V &amp;default_value) const</td></tr>
<tr class="memdesc:a84ccc9de1e12d064f1ccf77e344dd86b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns one value attached to 'key', or 'default_value' if 'key' is not in the multi-map. <a href="#a84ccc9de1e12d064f1ccf77e344dd86b">More...</a><br /></td></tr>
<tr class="separator:a84ccc9de1e12d064f1ccf77e344dd86b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00d0083447f546e8a43744ed5063e98d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html#a00d0083447f546e8a43744ed5063e98d">Insert</a> (const K &amp;key, const V &amp;value)</td></tr>
<tr class="memdesc:a00d0083447f546e8a43744ed5063e98d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inserts (key, value) in the multi-map. <a href="#a00d0083447f546e8a43744ed5063e98d">More...</a><br /></td></tr>
<tr class="separator:a00d0083447f546e8a43744ed5063e98d"><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;class K, class V&gt;<br />
class operations_research::RevImmutableMultiMap&lt; K, V &gt;</h3>
<p>--&mdash; Immutable Multi Map --&mdash; </p>
<p>Reversible Immutable MultiMap class. Represents an immutable multi-map that backtracks with the solver. </p>
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00294">294</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="afbd7546d603df82059ed3b8a13a3241a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbd7546d603df82059ed3b8a13a3241a">&#9670;&nbsp;</a></span>RevImmutableMultiMap()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class K , class V &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html">operations_research::RevImmutableMultiMap</a>&lt; K, V &gt;::<a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html">RevImmutableMultiMap</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const&#160;</td>
<td class="paramname"><em>solver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>initial_size</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="constraint__solveri_8h_source.html#l00296">296</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<a id="af8f8619f77a20868de764b036066dc3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8f8619f77a20868de764b036066dc3b">&#9670;&nbsp;</a></span>~RevImmutableMultiMap()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class K , class V &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html">operations_research::RevImmutableMultiMap</a>&lt; K, V &gt;::~<a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html">RevImmutableMultiMap</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="constraint__solveri_8h_source.html#l00304">304</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a55a49c7e6673d8ec5a30b3255899a23a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55a49c7e6673d8ec5a30b3255899a23a">&#9670;&nbsp;</a></span>ContainsKey()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class K , class V &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_1RevImmutableMultiMap.html">operations_research::RevImmutableMultiMap</a>&lt; K, V &gt;::ContainsKey </td>
<td>(</td>
<td class="paramtype">const K &amp;&#160;</td>
<td class="paramname"><em>key</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>Returns true if the multi-map contains at least one instance of 'key'. </p>
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00309">309</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<a id="a84ccc9de1e12d064f1ccf77e344dd86b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84ccc9de1e12d064f1ccf77e344dd86b">&#9670;&nbsp;</a></span>FindWithDefault()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class K , class V &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const V&amp; <a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html">operations_research::RevImmutableMultiMap</a>&lt; K, V &gt;::FindWithDefault </td>
<td>(</td>
<td class="paramtype">const K &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const V &amp;&#160;</td>
<td class="paramname"><em>default_value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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 one value attached to 'key', or 'default_value' if 'key' is not in the multi-map. </p>
<p>The actual value returned if more than one values is attached to the same key is not specified. </p>
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00324">324</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<a id="a00d0083447f546e8a43744ed5063e98d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00d0083447f546e8a43744ed5063e98d">&#9670;&nbsp;</a></span>Insert()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class K , class V &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_1RevImmutableMultiMap.html">operations_research::RevImmutableMultiMap</a>&lt; K, V &gt;::Insert </td>
<td>(</td>
<td class="paramtype">const K &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const V &amp;&#160;</td>
<td class="paramname"><em>value</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>Inserts (key, value) in the multi-map. </p>
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00337">337</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<a id="ae509969cf05f560f829ce4e0ed3aab1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae509969cf05f560f829ce4e0ed3aab1c">&#9670;&nbsp;</a></span>num_items()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class K , class V &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html">operations_research::RevImmutableMultiMap</a>&lt; K, V &gt;::num_items </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="constraint__solveri_8h_source.html#l00306">306</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a></li>
</ul>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink