Files
ortools-clone/docs/cpp_routing/classoperations__research_1_1Decision.html
Laurent Perron 0ac3fa17eb more linear doc
2019-07-15 17:42:24 -07:00

259 lines
13 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">OR-Tools 7.2</span>
</div>
</div>
<link rel="icon" href="https://developers.google.com/optimization/images/orLogo.png">
<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="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><!-- 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_1Decision.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classoperations__research_1_1Decision-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">operations_research::Decision Class Reference<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>A <a class="el" href="classoperations__research_1_1Decision.html" title="A Decision represents a choice point in the search tree.">Decision</a> represents a choice point in the search tree. </p>
<p>The two main methods are <a class="el" href="classoperations__research_1_1Decision.html#a88aea04b24727f86d465479464437b2e" title="Apply will be called first when the decision is executed.">Apply()</a> to go left, or <a class="el" href="classoperations__research_1_1Decision.html#a04e7498b68e7bfc7caeacad7c4272c1f" title="Refute will be called after a backtrack.">Refute()</a> to go right. </p>
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03165">3165</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:a20a827cbc3c6cf9ecbef85bc3ba85cdb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Decision.html#a20a827cbc3c6cf9ecbef85bc3ba85cdb">Decision</a> ()</td></tr>
<tr class="separator:a20a827cbc3c6cf9ecbef85bc3ba85cdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35ecb2123d8d852154e65847096b3f69"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Decision.html#a35ecb2123d8d852154e65847096b3f69">~Decision</a> () override</td></tr>
<tr class="separator:a35ecb2123d8d852154e65847096b3f69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88aea04b24727f86d465479464437b2e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Decision.html#a88aea04b24727f86d465479464437b2e">Apply</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const s)=0</td></tr>
<tr class="memdesc:a88aea04b24727f86d465479464437b2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apply will be called first when the decision is executed. <a href="#a88aea04b24727f86d465479464437b2e">More...</a><br /></td></tr>
<tr class="separator:a88aea04b24727f86d465479464437b2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04e7498b68e7bfc7caeacad7c4272c1f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Decision.html#a04e7498b68e7bfc7caeacad7c4272c1f">Refute</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const s)=0</td></tr>
<tr class="memdesc:a04e7498b68e7bfc7caeacad7c4272c1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Refute will be called after a backtrack. <a href="#a04e7498b68e7bfc7caeacad7c4272c1f">More...</a><br /></td></tr>
<tr class="separator:a04e7498b68e7bfc7caeacad7c4272c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c30db3cf86cc406442a05f5361fe4b9"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Decision.html#a8c30db3cf86cc406442a05f5361fe4b9">DebugString</a> () const override</td></tr>
<tr class="separator:a8c30db3cf86cc406442a05f5361fe4b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ac1f45476e2b62e48de4798adf8b911"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Decision.html#a5ac1f45476e2b62e48de4798adf8b911">Accept</a> (<a class="el" href="classoperations__research_1_1DecisionVisitor.html">DecisionVisitor</a> *const visitor) const</td></tr>
<tr class="memdesc:a5ac1f45476e2b62e48de4798adf8b911"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accepts the given visitor. <a href="#a5ac1f45476e2b62e48de4798adf8b911">More...</a><br /></td></tr>
<tr class="separator:a5ac1f45476e2b62e48de4798adf8b911"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a20a827cbc3c6cf9ecbef85bc3ba85cdb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20a827cbc3c6cf9ecbef85bc3ba85cdb">&#9670;&nbsp;</a></span>Decision()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">operations_research::Decision::Decision </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#l03167">3167</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="a35ecb2123d8d852154e65847096b3f69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35ecb2123d8d852154e65847096b3f69">&#9670;&nbsp;</a></span>~Decision()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">operations_research::Decision::~Decision </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#l03168">3168</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="a5ac1f45476e2b62e48de4798adf8b911"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ac1f45476e2b62e48de4798adf8b911">&#9670;&nbsp;</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">virtual void operations_research::Decision::Accept </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1DecisionVisitor.html">DecisionVisitor</a> *const&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Accepts the given visitor. </p>
</div>
</div>
<a id="a88aea04b24727f86d465479464437b2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88aea04b24727f86d465479464437b2e">&#9670;&nbsp;</a></span>Apply()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void operations_research::Decision::Apply </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const&#160;</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Apply will be called first when the decision is executed. </p>
</div>
</div>
<a id="a8c30db3cf86cc406442a05f5361fe4b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c30db3cf86cc406442a05f5361fe4b9">&#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">std::string operations_research::Decision::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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classoperations__research_1_1BaseObject.html#afb3b013c5063d71566d5273793c1d828">operations_research::BaseObject</a>.</p>
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03176">3176</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="a04e7498b68e7bfc7caeacad7c4272c1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04e7498b68e7bfc7caeacad7c4272c1f">&#9670;&nbsp;</a></span>Refute()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void operations_research::Decision::Refute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const&#160;</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Refute will be called after a backtrack. </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><!-- doc-content -->
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>