Files
ortools-clone/docs/cpp_routing/classoperations__research_1_1SolutionPool.html
Corentin Le Molgat 56440d30e5 Update docs to v7.5
2020-01-27 13:48:26 +01:00

290 lines
20 KiB
HTML

<!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="ortools.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">Google OR-Tools 7.5</span>
</div>
</div>
<div id="content" style="width: 100%; overflow: hidden;">
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
<h2>C++ Reference</h2>
<ul>
<li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
<li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
<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>
<div id="content">
<div align="center">
<h1 style="color: #145A32;">C++ Reference: Routing</h1>
</div>
<!-- Generated by Doxygen 1.8.18 -->
<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>
<li><a href="files.html"><span>Files</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_1SolutionPool.html">SolutionPool</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classoperations__research_1_1SolutionPool-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SolutionPool<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class is used to manage a pool of solutions. </p>
<p>It can transform a single point local search into a multipoint local search. </p>
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l05288">5288</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.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:a46aae4510235217253f419189cd0accf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SolutionPool.html#a46aae4510235217253f419189cd0accf">SolutionPool</a> ()</td></tr>
<tr class="separator:a46aae4510235217253f419189cd0accf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1eacd520fb6bd437786be473bffda1b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SolutionPool.html#aa1eacd520fb6bd437786be473bffda1b">~SolutionPool</a> () override</td></tr>
<tr class="separator:aa1eacd520fb6bd437786be473bffda1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa82c2dd754ff490f08768ed621d1f5b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SolutionPool.html#afa82c2dd754ff490f08768ed621d1f5b">Initialize</a> (<a class="el" href="classoperations__research_1_1Assignment.html">Assignment</a> *const assignment)=0</td></tr>
<tr class="memdesc:afa82c2dd754ff490f08768ed621d1f5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called to initialize the solution pool with the assignment from the local search. <a href="classoperations__research_1_1SolutionPool.html#afa82c2dd754ff490f08768ed621d1f5b">More...</a><br /></td></tr>
<tr class="separator:afa82c2dd754ff490f08768ed621d1f5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39b9785ffd2b768743ca541295668408"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SolutionPool.html#a39b9785ffd2b768743ca541295668408">RegisterNewSolution</a> (<a class="el" href="classoperations__research_1_1Assignment.html">Assignment</a> *const assignment)=0</td></tr>
<tr class="memdesc:a39b9785ffd2b768743ca541295668408"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called when a new solution has been accepted by the local search. <a href="classoperations__research_1_1SolutionPool.html#a39b9785ffd2b768743ca541295668408">More...</a><br /></td></tr>
<tr class="separator:a39b9785ffd2b768743ca541295668408"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fbedcc0e848833761bc0ed775aa5436"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SolutionPool.html#a6fbedcc0e848833761bc0ed775aa5436">GetNextSolution</a> (<a class="el" href="classoperations__research_1_1Assignment.html">Assignment</a> *const assignment)=0</td></tr>
<tr class="memdesc:a6fbedcc0e848833761bc0ed775aa5436"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called when the local search starts a new neighborhood to initialize the default assignment. <a href="classoperations__research_1_1SolutionPool.html#a6fbedcc0e848833761bc0ed775aa5436">More...</a><br /></td></tr>
<tr class="separator:a6fbedcc0e848833761bc0ed775aa5436"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ddd1c2f332c3cea0612b9d18ad6ef83"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SolutionPool.html#a0ddd1c2f332c3cea0612b9d18ad6ef83">SyncNeeded</a> (<a class="el" href="classoperations__research_1_1Assignment.html">Assignment</a> *const local_assignment)=0</td></tr>
<tr class="memdesc:a0ddd1c2f332c3cea0612b9d18ad6ef83"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method checks if the local solution needs to be updated with an external one. <a href="classoperations__research_1_1SolutionPool.html#a0ddd1c2f332c3cea0612b9d18ad6ef83">More...</a><br /></td></tr>
<tr class="separator:a0ddd1c2f332c3cea0612b9d18ad6ef83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8eba5d533fa9df4617c1868d3ec2afc4"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1BaseObject.html#a8eba5d533fa9df4617c1868d3ec2afc4">DebugString</a> () const</td></tr>
<tr class="separator:a8eba5d533fa9df4617c1868d3ec2afc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a46aae4510235217253f419189cd0accf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46aae4510235217253f419189cd0accf">&#9670;&nbsp;</a></span>SolutionPool()</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_1SolutionPool.html">SolutionPool</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__solver_8h_source.html#l05290">5290</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="aa1eacd520fb6bd437786be473bffda1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1eacd520fb6bd437786be473bffda1b">&#9670;&nbsp;</a></span>~SolutionPool()</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_1SolutionPool.html">SolutionPool</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 class="mlabel">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l05291">5291</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8eba5d533fa9df4617c1868d3ec2afc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8eba5d533fa9df4617c1868d3ec2afc4">&#9670;&nbsp;</a></span>DebugString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string DebugString </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 class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented in <a class="el" href="classoperations__research_1_1Pack.html#aed804747c45a7e1caf81461f9e45dd91">Pack</a>, <a class="el" href="classoperations__research_1_1Assignment.html#aed804747c45a7e1caf81461f9e45dd91">Assignment</a>, <a class="el" href="classoperations__research_1_1SequenceVar.html#aed804747c45a7e1caf81461f9e45dd91">SequenceVar</a>, <a class="el" href="classoperations__research_1_1RegularLimit.html#aed804747c45a7e1caf81461f9e45dd91">RegularLimit</a>, <a class="el" href="classoperations__research_1_1SearchLimit.html#aed804747c45a7e1caf81461f9e45dd91">SearchLimit</a>, <a class="el" href="classoperations__research_1_1OptimizeVar.html#aed804747c45a7e1caf81461f9e45dd91">OptimizeVar</a>, <a class="el" href="classoperations__research_1_1SolutionCollector.html#aed804747c45a7e1caf81461f9e45dd91">SolutionCollector</a>, <a class="el" href="classoperations__research_1_1IntVarIterator.html#aed804747c45a7e1caf81461f9e45dd91">IntVarIterator</a>, <a class="el" href="classoperations__research_1_1Constraint.html#aed804747c45a7e1caf81461f9e45dd91">Constraint</a>, <a class="el" href="classoperations__research_1_1CPFeasibilityFilter.html#aed804747c45a7e1caf81461f9e45dd91">CPFeasibilityFilter</a>, <a class="el" href="classoperations__research_1_1Demon.html#aed804747c45a7e1caf81461f9e45dd91">Demon</a>, <a class="el" href="classoperations__research_1_1DecisionBuilder.html#aed804747c45a7e1caf81461f9e45dd91">DecisionBuilder</a>, <a class="el" href="classoperations__research_1_1Decision.html#aed804747c45a7e1caf81461f9e45dd91">Decision</a>, <a class="el" href="classoperations__research_1_1PropagationBaseObject.html#aed804747c45a7e1caf81461f9e45dd91">PropagationBaseObject</a>, <a class="el" href="classoperations__research_1_1IntVarFilteredDecisionBuilder.html#aed804747c45a7e1caf81461f9e45dd91">IntVarFilteredDecisionBuilder</a>, <a class="el" href="classoperations__research_1_1ArrayWithOffset.html#aed804747c45a7e1caf81461f9e45dd91">ArrayWithOffset&lt; T &gt;</a>, <a class="el" href="classoperations__research_1_1SearchLog.html#aed804747c45a7e1caf81461f9e45dd91">SearchLog</a>, <a class="el" href="classoperations__research_1_1BooleanVar.html#aed804747c45a7e1caf81461f9e45dd91">BooleanVar</a>, <a class="el" href="classoperations__research_1_1LocalSearchMonitor.html#aed804747c45a7e1caf81461f9e45dd91">LocalSearchMonitor</a>, <a class="el" href="classoperations__research_1_1PropagationMonitor.html#aed804747c45a7e1caf81461f9e45dd91">PropagationMonitor</a>, <a class="el" href="classoperations__research_1_1GlobalVehicleBreaksConstraint.html#aed804747c45a7e1caf81461f9e45dd91">GlobalVehicleBreaksConstraint</a>, <a class="el" href="classoperations__research_1_1LocalSearchFilterManager.html#aed804747c45a7e1caf81461f9e45dd91">LocalSearchFilterManager</a>, <a class="el" href="classoperations__research_1_1DelayedCallMethod2.html#aed804747c45a7e1caf81461f9e45dd91">DelayedCallMethod2&lt; T, P, Q &gt;</a>, <a class="el" href="classoperations__research_1_1DelayedCallMethod1.html#aed804747c45a7e1caf81461f9e45dd91">DelayedCallMethod1&lt; T, P &gt;</a>, <a class="el" href="classoperations__research_1_1DelayedCallMethod0.html#aed804747c45a7e1caf81461f9e45dd91">DelayedCallMethod0&lt; T &gt;</a>, <a class="el" href="classoperations__research_1_1ExchangeSubtrip.html#aed804747c45a7e1caf81461f9e45dd91">ExchangeSubtrip</a>, <a class="el" href="classoperations__research_1_1CallMethod3.html#aed804747c45a7e1caf81461f9e45dd91">CallMethod3&lt; T, P, Q, R &gt;</a>, <a class="el" href="classoperations__research_1_1RelocateSubtrip.html#aed804747c45a7e1caf81461f9e45dd91">RelocateSubtrip</a>, <a class="el" href="classoperations__research_1_1CallMethod2.html#aed804747c45a7e1caf81461f9e45dd91">CallMethod2&lt; T, P, Q &gt;</a>, <a class="el" href="classoperations__research_1_1CallMethod1.html#aed804747c45a7e1caf81461f9e45dd91">CallMethod1&lt; T, P &gt;</a>, <a class="el" href="classoperations__research_1_1CallMethod0.html#aed804747c45a7e1caf81461f9e45dd91">CallMethod0&lt; T &gt;</a>, <a class="el" href="classoperations__research_1_1PairNodeSwapActiveOperator.html#aed804747c45a7e1caf81461f9e45dd91">PairNodeSwapActiveOperator&lt; swap_first &gt;</a>, <a class="el" href="classoperations__research_1_1RelocateExpensiveChain.html#aed804747c45a7e1caf81461f9e45dd91">RelocateExpensiveChain</a>, <a class="el" href="classoperations__research_1_1FilteredHeuristicExpensiveChainLNSOperator.html#aed804747c45a7e1caf81461f9e45dd91">FilteredHeuristicExpensiveChainLNSOperator</a>, <a class="el" href="classoperations__research_1_1FilteredHeuristicPathLNSOperator.html#aed804747c45a7e1caf81461f9e45dd91">FilteredHeuristicPathLNSOperator</a>, <a class="el" href="classoperations__research_1_1IndexPairSwapActiveOperator.html#aed804747c45a7e1caf81461f9e45dd91">IndexPairSwapActiveOperator</a>, <a class="el" href="classoperations__research_1_1SwapIndexPairOperator.html#aed804747c45a7e1caf81461f9e45dd91">SwapIndexPairOperator</a>, <a class="el" href="classoperations__research_1_1PairExchangeRelocateOperator.html#aed804747c45a7e1caf81461f9e45dd91">PairExchangeRelocateOperator</a>, <a class="el" href="classoperations__research_1_1PairExchangeOperator.html#aed804747c45a7e1caf81461f9e45dd91">PairExchangeOperator</a>, <a class="el" href="classoperations__research_1_1LightPairRelocateOperator.html#aed804747c45a7e1caf81461f9e45dd91">LightPairRelocateOperator</a>, <a class="el" href="classoperations__research_1_1PairRelocateOperator.html#aed804747c45a7e1caf81461f9e45dd91">PairRelocateOperator</a>, <a class="el" href="classoperations__research_1_1MakePairInactiveOperator.html#aed804747c45a7e1caf81461f9e45dd91">MakePairInactiveOperator</a>, <a class="el" href="classoperations__research_1_1MakePairActiveOperator.html#aed804747c45a7e1caf81461f9e45dd91">MakePairActiveOperator</a>, and <a class="el" href="classoperations__research_1_1MakeRelocateNeighborsOperator.html#aed804747c45a7e1caf81461f9e45dd91">MakeRelocateNeighborsOperator</a>.</p>
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03108">3108</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="a6fbedcc0e848833761bc0ed775aa5436"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fbedcc0e848833761bc0ed775aa5436">&#9670;&nbsp;</a></span>GetNextSolution()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void GetNextSolution </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Assignment.html">Assignment</a> *const&#160;</td>
<td class="paramname"><em>assignment</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is called when the local search starts a new neighborhood to initialize the default assignment. </p>
</div>
</div>
<a id="afa82c2dd754ff490f08768ed621d1f5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa82c2dd754ff490f08768ed621d1f5b">&#9670;&nbsp;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Assignment.html">Assignment</a> *const&#160;</td>
<td class="paramname"><em>assignment</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is called to initialize the solution pool with the assignment from the local search. </p>
</div>
</div>
<a id="a39b9785ffd2b768743ca541295668408"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39b9785ffd2b768743ca541295668408">&#9670;&nbsp;</a></span>RegisterNewSolution()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void RegisterNewSolution </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Assignment.html">Assignment</a> *const&#160;</td>
<td class="paramname"><em>assignment</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is called when a new solution has been accepted by the local search. </p>
</div>
</div>
<a id="a0ddd1c2f332c3cea0612b9d18ad6ef83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ddd1c2f332c3cea0612b9d18ad6ef83">&#9670;&nbsp;</a></span>SyncNeeded()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool SyncNeeded </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Assignment.html">Assignment</a> *const&#160;</td>
<td class="paramname"><em>local_assignment</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method checks if the local solution needs to be updated with an external one. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a></li>
</ul>
</div><!-- contents -->
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>