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

359 lines
18 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: LocalSearchOptimizer</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_1bop_1_1LocalSearchOptimizer.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="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classoperations__research_1_1bop_1_1LocalSearchOptimizer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LocalSearchOptimizer</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="bop__ls_8h_source.html#l00114">114</a> of file <a class="el" href="bop__ls_8h_source.html">bop_ls.h</a>.</p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> { <br />
&#160;&#160;<a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a67a0db04d321a74b7e7fcfd3f1a3f70bae276c6d6c33441e7bc41f349a9ba39e2">OPTIMAL_SOLUTION_FOUND</a>,
<a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba22ebbfba03095f407fb90f5a363a384b">SOLUTION_FOUND</a>,
<a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba2884fa43446c0cbc9c7a9b74d41d7483">INFEASIBLE</a>,
<a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba72c2402449caa8f3edc8aa0a3816baed">LIMIT_REACHED</a>,
<br />
&#160;&#160;<a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba896e21bf00faf87ec96b7d126be0641b">INFORMATION_FOUND</a>,
<a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba49959dd441dcda75d6898cf2c68fb374">CONTINUE</a>,
<a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba781ad2788df9e25c59a70894c7832096">ABORT</a>
<br />
}</td></tr>
<tr class="separator:a67a0db04d321a74b7e7fcfd3f1a3f70b"><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:abd80d05b43433461f15ef74312679af6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1bop_1_1LocalSearchOptimizer.html#abd80d05b43433461f15ef74312679af6">LocalSearchOptimizer</a> (const std::string &amp;<a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#ad8227ba86a01f26e4f173cd5e219d5d1">name</a>, int max_num_decisions, <a class="el" href="classoperations__research_1_1sat_1_1SatSolver.html">sat::SatSolver</a> *sat_propagator)</td></tr>
<tr class="separator:abd80d05b43433461f15ef74312679af6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adccc3ffb94c7359656258de436e713c2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1bop_1_1LocalSearchOptimizer.html#adccc3ffb94c7359656258de436e713c2">~LocalSearchOptimizer</a> () override</td></tr>
<tr class="separator:adccc3ffb94c7359656258de436e713c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8227ba86a01f26e4f173cd5e219d5d1"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#ad8227ba86a01f26e4f173cd5e219d5d1">name</a> () const</td></tr>
<tr class="separator:ad8227ba86a01f26e4f173cd5e219d5d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a251e0a163e38833f5ac06582342143bd"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a251e0a163e38833f5ac06582342143bd">GetStatusString</a> (<a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> status)</td></tr>
<tr class="separator:a251e0a163e38833f5ac06582342143bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a723d30392e2c4f36252de0528a1b246d"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a723d30392e2c4f36252de0528a1b246d">name_</a></td></tr>
<tr class="separator:a723d30392e2c4f36252de0528a1b246d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c6fc06ca542eed0ff0b6ed4b1ecbcda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoperations__research_1_1StatsGroup.html">StatsGroup</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a7c6fc06ca542eed0ff0b6ed4b1ecbcda">stats_</a></td></tr>
<tr class="separator:a7c6fc06ca542eed0ff0b6ed4b1ecbcda"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a67a0db04d321a74b7e7fcfd3f1a3f70b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67a0db04d321a74b7e7fcfd3f1a3f70b">&#9670;&nbsp;</a></span>Status</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70bae276c6d6c33441e7bc41f349a9ba39e2"></a>OPTIMAL_SOLUTION_FOUND&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba22ebbfba03095f407fb90f5a363a384b"></a>SOLUTION_FOUND&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba2884fa43446c0cbc9c7a9b74d41d7483"></a>INFEASIBLE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba72c2402449caa8f3edc8aa0a3816baed"></a>LIMIT_REACHED&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba896e21bf00faf87ec96b7d126be0641b"></a>INFORMATION_FOUND&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba49959dd441dcda75d6898cf2c68fb374"></a>CONTINUE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba781ad2788df9e25c59a70894c7832096"></a>ABORT&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="bop__base_8h_source.html#l00061">61</a> of file <a class="el" href="bop__base_8h_source.html">bop_base.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abd80d05b43433461f15ef74312679af6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd80d05b43433461f15ef74312679af6">&#9670;&nbsp;</a></span>LocalSearchOptimizer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1bop_1_1LocalSearchOptimizer.html">LocalSearchOptimizer</a> </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>max_num_decisions</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1sat_1_1SatSolver.html">sat::SatSolver</a> *&#160;</td>
<td class="paramname"><em>sat_propagator</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bop__ls_8cc_source.html#l00032">32</a> of file <a class="el" href="bop__ls_8cc_source.html">bop_ls.cc</a>.</p>
</div>
</div>
<a id="adccc3ffb94c7359656258de436e713c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adccc3ffb94c7359656258de436e713c2">&#9670;&nbsp;</a></span>~LocalSearchOptimizer()</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_1bop_1_1LocalSearchOptimizer.html">LocalSearchOptimizer</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">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bop__ls_8cc_source.html#l00041">41</a> of file <a class="el" href="bop__ls_8cc_source.html">bop_ls.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a251e0a163e38833f5ac06582342143bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a251e0a163e38833f5ac06582342143bd">&#9670;&nbsp;</a></span>GetStatusString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string GetStatusString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1bop_1_1BopOptimizerBase.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bop__base_8cc_source.html#l00038">38</a> of file <a class="el" href="bop__base_8cc_source.html">bop_base.cc</a>.</p>
</div>
</div>
<a id="ad8227ba86a01f26e4f173cd5e219d5d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8227ba86a01f26e4f173cd5e219d5d1">&#9670;&nbsp;</a></span>name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string&amp; name </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">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bop__base_8h_source.html#l00046">46</a> of file <a class="el" href="bop__base_8h_source.html">bop_base.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a723d30392e2c4f36252de0528a1b246d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a723d30392e2c4f36252de0528a1b246d">&#9670;&nbsp;</a></span>name_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string name_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bop__base_8h_source.html#l00098">98</a> of file <a class="el" href="bop__base_8h_source.html">bop_base.h</a>.</p>
</div>
</div>
<a id="a7c6fc06ca542eed0ff0b6ed4b1ecbcda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c6fc06ca542eed0ff0b6ed4b1ecbcda">&#9670;&nbsp;</a></span>stats_</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_1StatsGroup.html">StatsGroup</a> stats_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bop__base_8h_source.html#l00100">100</a> of file <a class="el" href="bop__base_8h_source.html">bop_base.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="bop__ls_8h_source.html">bop_ls.h</a></li>
<li><a class="el" href="bop__ls_8cc_source.html">bop_ls.cc</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="namespaceoperations__research_1_1bop.html">bop</a></li><li class="navelem"><a class="el" href="classoperations__research_1_1bop_1_1LocalSearchOptimizer.html">LocalSearchOptimizer</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>