333 lines
17 KiB
HTML
333 lines
17 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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: SweepBuilder</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
|
|
 <span id="projectnumber">8.2</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classoperations__research_1_1_sweep_builder.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-methods">Public Member Functions</a> |
|
|
<a href="classoperations__research_1_1_sweep_builder-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">SweepBuilder</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="routing_8cc_source.html#l03026">3026</a> of file <a class="el" href="routing_8cc_source.html">routing.cc</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:a8a7ce510e251b4fa2533fec825773e97"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_sweep_builder.html#a8a7ce510e251b4fa2533fec825773e97">SweepBuilder</a> (<a class="el" href="classoperations__research_1_1_routing_model.html">RoutingModel</a> *const <a class="el" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>, bool check_assignment)</td></tr>
|
|
<tr class="separator:a8a7ce510e251b4fa2533fec825773e97"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0353fa7a09f5b17b37b1e9bf933fc48b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_sweep_builder.html#a0353fa7a09f5b17b37b1e9bf933fc48b">~SweepBuilder</a> () override</td></tr>
|
|
<tr class="separator:a0353fa7a09f5b17b37b1e9bf933fc48b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5251132b6ab1df4f1ccd864f239f1d9b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoperations__research_1_1_decision.html">Decision</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_sweep_builder.html#a5251132b6ab1df4f1ccd864f239f1d9b">Next</a> (<a class="el" href="classoperations__research_1_1_solver.html">Solver</a> *const solver) override</td></tr>
|
|
<tr class="memdesc:a5251132b6ab1df4f1ccd864f239f1d9b"><td class="mdescLeft"> </td><td class="mdescRight">This is the main method of the decision builder class. <a href="classoperations__research_1_1_sweep_builder.html#a5251132b6ab1df4f1ccd864f239f1d9b">More...</a><br /></td></tr>
|
|
<tr class="separator:a5251132b6ab1df4f1ccd864f239f1d9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed804747c45a7e1caf81461f9e45dd91"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_decision_builder.html#aed804747c45a7e1caf81461f9e45dd91">DebugString</a> () const override</td></tr>
|
|
<tr class="separator:aed804747c45a7e1caf81461f9e45dd91"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba5193a76f57d66707f9256ac1d6cc78"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_decision_builder.html#aba5193a76f57d66707f9256ac1d6cc78">AppendMonitors</a> (<a class="el" href="classoperations__research_1_1_solver.html">Solver</a> *const solver, std::vector< <a class="el" href="classoperations__research_1_1_search_monitor.html">SearchMonitor</a> * > *const extras)</td></tr>
|
|
<tr class="memdesc:aba5193a76f57d66707f9256ac1d6cc78"><td class="mdescLeft"> </td><td class="mdescRight">This method will be called at the start of the search. <a href="classoperations__research_1_1_decision_builder.html#aba5193a76f57d66707f9256ac1d6cc78">More...</a><br /></td></tr>
|
|
<tr class="separator:aba5193a76f57d66707f9256ac1d6cc78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac4aa5ecf086378b1bbac4b669bab4db"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_decision_builder.html#aac4aa5ecf086378b1bbac4b669bab4db">Accept</a> (<a class="el" href="classoperations__research_1_1_model_visitor.html">ModelVisitor</a> *const visitor) const</td></tr>
|
|
<tr class="separator:aac4aa5ecf086378b1bbac4b669bab4db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a8a7ce510e251b4fa2533fec825773e97"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8a7ce510e251b4fa2533fec825773e97">◆ </a></span>SweepBuilder()</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_1_sweep_builder.html">SweepBuilder</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classoperations__research_1_1_routing_model.html">RoutingModel</a> *const </td>
|
|
<td class="paramname"><em>model</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>check_assignment</em> </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="routing_8cc_source.html#l03028">3028</a> of file <a class="el" href="routing_8cc_source.html">routing.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0353fa7a09f5b17b37b1e9bf933fc48b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0353fa7a09f5b17b37b1e9bf933fc48b">◆ </a></span>~SweepBuilder()</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_1_sweep_builder.html">SweepBuilder</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="routing_8cc_source.html#l03030">3030</a> of file <a class="el" href="routing_8cc_source.html">routing.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aac4aa5ecf086378b1bbac4b669bab4db"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac4aa5ecf086378b1bbac4b669bab4db">◆ </a></span>Accept()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Accept </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classoperations__research_1_1_model_visitor.html">ModelVisitor</a> *const </td>
|
|
<td class="paramname"><em>visitor</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="constraint__solver_8cc_source.html#l02532">2532</a> of file <a class="el" href="constraint__solver_8cc_source.html">constraint_solver.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aba5193a76f57d66707f9256ac1d6cc78"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba5193a76f57d66707f9256ac1d6cc78">◆ </a></span>AppendMonitors()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void AppendMonitors </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classoperations__research_1_1_solver.html">Solver</a> *const </td>
|
|
<td class="paramname"><em>solver</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::vector< <a class="el" href="classoperations__research_1_1_search_monitor.html">SearchMonitor</a> * > *const </td>
|
|
<td class="paramname"><em>extras</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This method will be called at the start of the search. </p>
|
|
<p>It asks the decision builder if it wants to append search monitors to the list of active monitors for this search. Please note there are no checks at this point for duplication. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="constraint__solver_8cc_source.html#l02529">2529</a> of file <a class="el" href="constraint__solver_8cc_source.html">constraint_solver.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aed804747c45a7e1caf81461f9e45dd91"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aed804747c45a7e1caf81461f9e45dd91">◆ </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">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">override</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented from <a class="el" href="classoperations__research_1_1_base_object.html#a8eba5d533fa9df4617c1868d3ec2afc4">BaseObject</a>.</p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classoperations__research_1_1_int_var_filtered_decision_builder.html#aed804747c45a7e1caf81461f9e45dd91">IntVarFilteredDecisionBuilder</a>, <a class="el" href="classoperations__research_1_1_find_one_neighbor.html#aed804747c45a7e1caf81461f9e45dd91">FindOneNeighbor</a>, <a class="el" href="class_swig_director___decision_builder.html#a8eba5d533fa9df4617c1868d3ec2afc4">SwigDirector_DecisionBuilder</a>, <a class="el" href="class_swig_director___decision_builder.html#a8eba5d533fa9df4617c1868d3ec2afc4">SwigDirector_DecisionBuilder</a>, and <a class="el" href="class_swig_director___decision_builder.html#a764be64f3029f8b8e23511061d8de355">SwigDirector_DecisionBuilder</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="constraint__solver_8cc_source.html#l02527">2527</a> of file <a class="el" href="constraint__solver_8cc_source.html">constraint_solver.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5251132b6ab1df4f1ccd864f239f1d9b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5251132b6ab1df4f1ccd864f239f1d9b">◆ </a></span>Next()</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_1_decision.html">Decision</a>* Next </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classoperations__research_1_1_solver.html">Solver</a> *const </td>
|
|
<td class="paramname"><em>s</em></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 class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is the main method of the decision builder class. </p>
|
|
<p>It must return a decision (an instance of the class <a class="el" href="classoperations__research_1_1_decision.html" title="A Decision represents a choice point in the search tree.">Decision</a>). If it returns nullptr, this means that the decision builder has finished its work. </p>
|
|
|
|
<p>Implements <a class="el" href="classoperations__research_1_1_decision_builder.html#a68bbb37d42da9d7b82145b3bf435dbc3">DecisionBuilder</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="routing_8cc_source.html#l03032">3032</a> of file <a class="el" href="routing_8cc_source.html">routing.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="routing_8cc_source.html">routing.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="classoperations__research_1_1_sweep_builder.html">SweepBuilder</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.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|