Files
ortools-clone/docs/cpp/classoperations__research_1_1_decision.html
2021-04-27 23:00:03 +02:00

316 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: Decision</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">9.0</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&amp;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&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_1_decision.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> &#124;
<a href="classoperations__research_1_1_decision-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Decision<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_1_decision.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_1_decision.html#a4adc076f6a88e85584762d4b7f30a820" title="Apply will be called first when the decision is executed.">Apply()</a> to go left, or <a class="el" href="classoperations__research_1_1_decision.html#a8b28baa822da63142e875e1258fe0973" 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#l03230">3230</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:abd62b993702516d946bdbef25f6d29b0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_decision.html#abd62b993702516d946bdbef25f6d29b0">Decision</a> ()</td></tr>
<tr class="separator:abd62b993702516d946bdbef25f6d29b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51b2fa6aacf500666d37f0a73eb57c45"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_decision.html#a51b2fa6aacf500666d37f0a73eb57c45">~Decision</a> () override</td></tr>
<tr class="separator:a51b2fa6aacf500666d37f0a73eb57c45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4adc076f6a88e85584762d4b7f30a820"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_decision.html#a4adc076f6a88e85584762d4b7f30a820">Apply</a> (<a class="el" href="classoperations__research_1_1_solver.html">Solver</a> *const s)=0</td></tr>
<tr class="memdesc:a4adc076f6a88e85584762d4b7f30a820"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apply will be called first when the decision is executed. <a href="classoperations__research_1_1_decision.html#a4adc076f6a88e85584762d4b7f30a820">More...</a><br /></td></tr>
<tr class="separator:a4adc076f6a88e85584762d4b7f30a820"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b28baa822da63142e875e1258fe0973"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_decision.html#a8b28baa822da63142e875e1258fe0973">Refute</a> (<a class="el" href="classoperations__research_1_1_solver.html">Solver</a> *const s)=0</td></tr>
<tr class="memdesc:a8b28baa822da63142e875e1258fe0973"><td class="mdescLeft">&#160;</td><td class="mdescRight">Refute will be called after a backtrack. <a href="classoperations__research_1_1_decision.html#a8b28baa822da63142e875e1258fe0973">More...</a><br /></td></tr>
<tr class="separator:a8b28baa822da63142e875e1258fe0973"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed804747c45a7e1caf81461f9e45dd91"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_decision.html#aed804747c45a7e1caf81461f9e45dd91">DebugString</a> () const override</td></tr>
<tr class="separator:aed804747c45a7e1caf81461f9e45dd91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3acdd325e92a8174c158f99e273d4cbd"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_decision.html#a3acdd325e92a8174c158f99e273d4cbd">Accept</a> (<a class="el" href="classoperations__research_1_1_decision_visitor.html">DecisionVisitor</a> *const visitor) const</td></tr>
<tr class="memdesc:a3acdd325e92a8174c158f99e273d4cbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accepts the given visitor. <a href="classoperations__research_1_1_decision.html#a3acdd325e92a8174c158f99e273d4cbd">More...</a><br /></td></tr>
<tr class="separator:a3acdd325e92a8174c158f99e273d4cbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abd62b993702516d946bdbef25f6d29b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd62b993702516d946bdbef25f6d29b0">&#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"><a class="el" href="classoperations__research_1_1_decision.html">Decision</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#l03232">3232</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="a51b2fa6aacf500666d37f0a73eb57c45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51b2fa6aacf500666d37f0a73eb57c45">&#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">~<a class="el" href="classoperations__research_1_1_decision.html">Decision</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#l03233">3233</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="a3acdd325e92a8174c158f99e273d4cbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3acdd325e92a8174c158f99e273d4cbd">&#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">void Accept </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1_decision_visitor.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>
<p>Reimplemented in <a class="el" href="class_swig_director___decision.html#af75540a6a4cc107b22eb1e0c7d188690">SwigDirector_Decision</a>, and <a class="el" href="class_swig_director___decision.html#a4aaf50f0ff59f675220c02d9c1cf0a1c">SwigDirector_Decision</a>.</p>
<p class="definition">Definition at line <a class="el" href="constraint__solver_8cc_source.html#l02541">2541</a> of file <a class="el" href="constraint__solver_8cc_source.html">constraint_solver.cc</a>.</p>
</div>
</div>
<a id="a4adc076f6a88e85584762d4b7f30a820"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4adc076f6a88e85584762d4b7f30a820">&#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 Apply </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1_solver.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>
<p>Implemented in <a class="el" href="class_swig_director___decision.html#adab8c70c8471708e5ff8402d79145a69">SwigDirector_Decision</a>, <a class="el" href="class_swig_director___decision.html#adab8c70c8471708e5ff8402d79145a69">SwigDirector_Decision</a>, and <a class="el" href="class_swig_director___decision.html#aa461a69519a44bb1b51b883d79c83fd1">SwigDirector_Decision</a>.</p>
</div>
</div>
<a id="aed804747c45a7e1caf81461f9e45dd91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed804747c45a7e1caf81461f9e45dd91">&#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 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_1_base_object.html#a8eba5d533fa9df4617c1868d3ec2afc4">BaseObject</a>.</p>
<p>Reimplemented in <a class="el" href="class_swig_director___decision.html#a8eba5d533fa9df4617c1868d3ec2afc4">SwigDirector_Decision</a>, <a class="el" href="class_swig_director___decision.html#a8eba5d533fa9df4617c1868d3ec2afc4">SwigDirector_Decision</a>, and <a class="el" href="class_swig_director___decision.html#a764be64f3029f8b8e23511061d8de355">SwigDirector_Decision</a>.</p>
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03241">3241</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="a8b28baa822da63142e875e1258fe0973"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b28baa822da63142e875e1258fe0973">&#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 Refute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1_solver.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>
<p>Implemented in <a class="el" href="class_swig_director___decision.html#a44447967e4a4b388147d77f6b350f487">SwigDirector_Decision</a>, <a class="el" href="class_swig_director___decision.html#a44447967e4a4b388147d77f6b350f487">SwigDirector_Decision</a>, and <a class="el" href="class_swig_director___decision.html#aff30824ca830557ffffb0c9545e92669">SwigDirector_Decision</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a></li>
<li><a class="el" href="constraint__solver_8cc_source.html">constraint_solver.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_decision.html">Decision</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>