Files
ortools-clone/docs/cpp/classoperations__research_1_1RevImmutableMultiMap.html
2020-09-01 16:01:06 +02:00

345 lines
16 KiB
HTML

<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: RevImmutableMultiMap&lt; K, V &gt;</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="styleSheet.tmp.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="orLogo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
&#160;<span id="projectnumber">8.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</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">
</div>
</div>
<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_1RevImmutableMultiMap.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<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">RevImmutableMultiMap&lt; K, V &gt;</div> </div>
</div><!--header-->
<div class="contents">
<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>Reversible Immutable MultiMap class. </p>
<p>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#l00288">288</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div><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:a3c7e62a9a396c5d8fd2b85b762c2a850"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html#a3c7e62a9a396c5d8fd2b85b762c2a850">RevImmutableMultiMap</a> (Solver *const solver, int initial_size)</td></tr>
<tr class="separator:a3c7e62a9a396c5d8fd2b85b762c2a850"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6053bb9c0d664074153ddfd9c7cd2598"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html#a6053bb9c0d664074153ddfd9c7cd2598">~RevImmutableMultiMap</a> ()</td></tr>
<tr class="separator:a6053bb9c0d664074153ddfd9c7cd2598"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab273f390966237d6f5cdb9c45f5361d6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html#ab273f390966237d6f5cdb9c45f5361d6">num_items</a> () const</td></tr>
<tr class="separator:ab273f390966237d6f5cdb9c45f5361d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f6b848968f58150836b9fba3dea4aef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html#a8f6b848968f58150836b9fba3dea4aef">ContainsKey</a> (const K &amp;key) const</td></tr>
<tr class="memdesc:a8f6b848968f58150836b9fba3dea4aef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the multi-map contains at least one instance of 'key'. <a href="classoperations__research_1_1RevImmutableMultiMap.html#a8f6b848968f58150836b9fba3dea4aef">More...</a><br /></td></tr>
<tr class="separator:a8f6b848968f58150836b9fba3dea4aef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdfc0716a485fde5b997f58b1c4c822e"><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#abdfc0716a485fde5b997f58b1c4c822e">FindWithDefault</a> (const K &amp;key, const V &amp;default_value) const</td></tr>
<tr class="memdesc:abdfc0716a485fde5b997f58b1c4c822e"><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="classoperations__research_1_1RevImmutableMultiMap.html#abdfc0716a485fde5b997f58b1c4c822e">More...</a><br /></td></tr>
<tr class="separator:abdfc0716a485fde5b997f58b1c4c822e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b5c13dc004b78fa86ae2a2e76f25f99"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html#a0b5c13dc004b78fa86ae2a2e76f25f99">Insert</a> (const K &amp;key, const V &amp;<a class="el" href="matrix__utils_8cc.html#aee90379adb0307effb138f4871edbc5c">value</a>)</td></tr>
<tr class="memdesc:a0b5c13dc004b78fa86ae2a2e76f25f99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inserts (key, value) in the multi-map. <a href="classoperations__research_1_1RevImmutableMultiMap.html#a0b5c13dc004b78fa86ae2a2e76f25f99">More...</a><br /></td></tr>
<tr class="separator:a0b5c13dc004b78fa86ae2a2e76f25f99"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3c7e62a9a396c5d8fd2b85b762c2a850"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c7e62a9a396c5d8fd2b85b762c2a850">&#9670;&nbsp;</a></span>RevImmutableMultiMap()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1RevImmutableMultiMap.html">RevImmutableMultiMap</a> </td>
<td>(</td>
<td class="paramtype">Solver *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#l00290">290</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<a id="a6053bb9c0d664074153ddfd9c7cd2598"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6053bb9c0d664074153ddfd9c7cd2598">&#9670;&nbsp;</a></span>~RevImmutableMultiMap()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">~<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#l00298">298</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="a8f6b848968f58150836b9fba3dea4aef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f6b848968f58150836b9fba3dea4aef">&#9670;&nbsp;</a></span>ContainsKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool 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#l00303">303</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<a id="abdfc0716a485fde5b997f58b1c4c822e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdfc0716a485fde5b997f58b1c4c822e">&#9670;&nbsp;</a></span>FindWithDefault()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const V&amp; 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#l00318">318</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<a id="a0b5c13dc004b78fa86ae2a2e76f25f99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b5c13dc004b78fa86ae2a2e76f25f99">&#9670;&nbsp;</a></span>Insert()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void 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#l00331">331</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<a id="ab273f390966237d6f5cdb9c45f5361d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab273f390966237d6f5cdb9c45f5361d6">&#9670;&nbsp;</a></span>num_items()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int 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#l00300">300</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><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<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>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li>
</ul>
</div>
</body>
</html>