599 lines
35 KiB
HTML
599 lines
35 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.1@</span>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</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 id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</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_1PropagationBaseObject.html">PropagationBaseObject</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classoperations__research_1_1PropagationBaseObject-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">operations_research::PropagationBaseObject Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The <a class="el" href="classoperations__research_1_1PropagationBaseObject.html" title="The PropagationBaseObject is a subclass of BaseObject that is also friend to the Solver class.">PropagationBaseObject</a> is a subclass of <a class="el" href="classoperations__research_1_1BaseObject.html" title="Useful Search and Modeling Objects.">BaseObject</a> that is also friend to the <a class="el" href="classoperations__research_1_1Solver.html" title="Solver Class.">Solver</a> class.
|
|
<a href="classoperations__research_1_1PropagationBaseObject.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for operations_research::PropagationBaseObject:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classoperations__research_1_1PropagationBaseObject__inherit__graph.png" border="0" usemap="#operations__research_1_1PropagationBaseObject_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="operations__research_1_1PropagationBaseObject_inherit__map" id="operations__research_1_1PropagationBaseObject_inherit__map">
|
|
<area shape="rect" title="The PropagationBaseObject is a subclass of BaseObject that is also friend to the Solver class." alt="" coords="196,131,366,169"/>
|
|
<area shape="rect" href="classoperations__research_1_1Assignment.html" title="--â Assignment --â" alt="" coords="414,5,557,44"/>
|
|
<area shape="rect" href="classoperations__research_1_1Constraint.html" title="A constraint is the main modeling object." alt="" coords="414,68,557,107"/>
|
|
<area shape="rect" href="classoperations__research_1_1IntervalVar.html" title="-------â Interval Var -------â" alt="" coords="414,131,557,169"/>
|
|
<area shape="rect" href="classoperations__research_1_1IntExpr.html" title="The class IntExpr is the base of all integer expressions in constraint programming." alt="" coords="414,193,557,232"/>
|
|
<area shape="rect" href="classoperations__research_1_1SequenceVar.html" title="--â SequenceVar --â" alt="" coords="414,256,557,295"/>
|
|
<area shape="rect" href="classoperations__research_1_1BaseObject.html" title="Useful Search and Modeling Objects." alt="" coords="5,131,148,169"/>
|
|
<area shape="rect" href="classoperations__research_1_1CastConstraint.html" title="Cast constraints are special channeling constraints designed to keep a variable in sync with an expre..." alt="" coords="610,5,753,44"/>
|
|
<area shape="rect" href="classoperations__research_1_1DisjunctiveConstraint.html" title="--â Disjunctive Constraint --â" alt="" coords="605,68,759,107"/>
|
|
<area shape="rect" href="classoperations__research_1_1Pack.html" title="-------â Pack Constraint -------â" alt="" coords="610,131,753,169"/>
|
|
<area shape="rect" href="classoperations__research_1_1BaseIntExpr.html" title="This is the base class for all expressions that are not variables." alt="" coords="610,193,753,232"/>
|
|
<area shape="rect" href="classoperations__research_1_1IntVar.html" title="The class IntVar is a subset of IntExpr." alt="" coords="610,256,753,295"/>
|
|
<area shape="rect" href="classoperations__research_1_1BooleanVar.html" title="--â Boolean Variable --â" alt="" coords="807,256,950,295"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for operations_research::PropagationBaseObject:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classoperations__research_1_1PropagationBaseObject__coll__graph.png" border="0" usemap="#operations__research_1_1PropagationBaseObject_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="operations__research_1_1PropagationBaseObject_coll__map" id="operations__research_1_1PropagationBaseObject_coll__map">
|
|
<area shape="rect" title="The PropagationBaseObject is a subclass of BaseObject that is also friend to the Solver class." alt="" coords="5,92,175,131"/>
|
|
<area shape="rect" href="classoperations__research_1_1BaseObject.html" title="Useful Search and Modeling Objects." alt="" coords="19,5,162,44"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></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:afa9385e35090e310e58fc4cb6fd5d606"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#afa9385e35090e310e58fc4cb6fd5d606">PropagationBaseObject</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const s)</td></tr>
|
|
<tr class="separator:afa9385e35090e310e58fc4cb6fd5d606"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a767a917fc7d9232d121994ae1e124875"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a767a917fc7d9232d121994ae1e124875">~PropagationBaseObject</a> () override</td></tr>
|
|
<tr class="separator:a767a917fc7d9232d121994ae1e124875"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5b6f8cb73c1b76da152ad612f91c4ce"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#ae5b6f8cb73c1b76da152ad612f91c4ce">DebugString</a> () const override</td></tr>
|
|
<tr class="separator:ae5b6f8cb73c1b76da152ad612f91c4ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab3aa61657c74294f198a16d1dbc52580"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoperations__research_1_1Solver.html">Solver</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#ab3aa61657c74294f198a16d1dbc52580">solver</a> () const</td></tr>
|
|
<tr class="separator:ab3aa61657c74294f198a16d1dbc52580"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78b16596f589dd63573a1586f61c2dbd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a78b16596f589dd63573a1586f61c2dbd">FreezeQueue</a> ()</td></tr>
|
|
<tr class="memdesc:a78b16596f589dd63573a1586f61c2dbd"><td class="mdescLeft"> </td><td class="mdescRight">This method freezes the propagation queue. <a href="#a78b16596f589dd63573a1586f61c2dbd">More...</a><br /></td></tr>
|
|
<tr class="separator:a78b16596f589dd63573a1586f61c2dbd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97782b79fbcf8043201fefaa7729dcf1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a97782b79fbcf8043201fefaa7729dcf1">UnfreezeQueue</a> ()</td></tr>
|
|
<tr class="memdesc:a97782b79fbcf8043201fefaa7729dcf1"><td class="mdescLeft"> </td><td class="mdescRight">This method unfreezes the propagation queue. <a href="#a97782b79fbcf8043201fefaa7729dcf1">More...</a><br /></td></tr>
|
|
<tr class="separator:a97782b79fbcf8043201fefaa7729dcf1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5dd87cd906d80738f8727fda04bc5ace"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a5dd87cd906d80738f8727fda04bc5ace">EnqueueDelayedDemon</a> (<a class="el" href="classoperations__research_1_1Demon.html">Demon</a> *const d)</td></tr>
|
|
<tr class="memdesc:a5dd87cd906d80738f8727fda04bc5ace"><td class="mdescLeft"> </td><td class="mdescRight">This method pushes the demon onto the propagation queue. <a href="#a5dd87cd906d80738f8727fda04bc5ace">More...</a><br /></td></tr>
|
|
<tr class="separator:a5dd87cd906d80738f8727fda04bc5ace"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3fe6115081d583d57b6cd8b0dd1783d7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a3fe6115081d583d57b6cd8b0dd1783d7">EnqueueVar</a> (<a class="el" href="classoperations__research_1_1Demon.html">Demon</a> *const d)</td></tr>
|
|
<tr class="separator:a3fe6115081d583d57b6cd8b0dd1783d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a7285479f5e0fa7663c043cdfc7dd61"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a4a7285479f5e0fa7663c043cdfc7dd61">ExecuteAll</a> (const <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">SimpleRevFIFO</a>< <a class="el" href="classoperations__research_1_1Demon.html">Demon</a> * > &demons)</td></tr>
|
|
<tr class="separator:a4a7285479f5e0fa7663c043cdfc7dd61"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5975e144479d99ceae4f009472ca5e92"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a5975e144479d99ceae4f009472ca5e92">EnqueueAll</a> (const <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">SimpleRevFIFO</a>< <a class="el" href="classoperations__research_1_1Demon.html">Demon</a> * > &demons)</td></tr>
|
|
<tr class="separator:a5975e144479d99ceae4f009472ca5e92"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c6bf90bb0b099a2c8f81aaefdfdd46c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a5c6bf90bb0b099a2c8f81aaefdfdd46c">set_action_on_fail</a> (<a class="el" href="classoperations__research_1_1Solver.html#a87ca0b6abf9c8724900387f5aa557c04">Solver::Action</a> a)</td></tr>
|
|
<tr class="memdesc:a5c6bf90bb0b099a2c8f81aaefdfdd46c"><td class="mdescLeft"> </td><td class="mdescRight">This method sets a callback that will be called if a failure happens during the propagation of the queue. <a href="#a5c6bf90bb0b099a2c8f81aaefdfdd46c">More...</a><br /></td></tr>
|
|
<tr class="separator:a5c6bf90bb0b099a2c8f81aaefdfdd46c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad07aa613bcc8d3896dff3f33520b061c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#ad07aa613bcc8d3896dff3f33520b061c">reset_action_on_fail</a> ()</td></tr>
|
|
<tr class="memdesc:ad07aa613bcc8d3896dff3f33520b061c"><td class="mdescLeft"> </td><td class="mdescRight">This method clears the failure callback. <a href="#ad07aa613bcc8d3896dff3f33520b061c">More...</a><br /></td></tr>
|
|
<tr class="separator:ad07aa613bcc8d3896dff3f33520b061c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d2ccb8a806df14394b3271791c81e61"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a4d2ccb8a806df14394b3271791c81e61">set_variable_to_clean_on_fail</a> (<a class="el" href="classoperations__research_1_1IntVar.html">IntVar</a> *v)</td></tr>
|
|
<tr class="memdesc:a4d2ccb8a806df14394b3271791c81e61"><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for variable cleaner. <a href="#a4d2ccb8a806df14394b3271791c81e61">More...</a><br /></td></tr>
|
|
<tr class="separator:a4d2ccb8a806df14394b3271791c81e61"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8be8b75223b76744791e48747677cdb6"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a8be8b75223b76744791e48747677cdb6">name</a> () const</td></tr>
|
|
<tr class="memdesc:a8be8b75223b76744791e48747677cdb6"><td class="mdescLeft"> </td><td class="mdescRight">Object naming. <a href="#a8be8b75223b76744791e48747677cdb6">More...</a><br /></td></tr>
|
|
<tr class="separator:a8be8b75223b76744791e48747677cdb6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d4a4cf402b353ba2908836656cf0c62"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a5d4a4cf402b353ba2908836656cf0c62">set_name</a> (const std::string &<a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a8be8b75223b76744791e48747677cdb6">name</a>)</td></tr>
|
|
<tr class="separator:a5d4a4cf402b353ba2908836656cf0c62"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6e627822f954d6072125c1d152c30f8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#af6e627822f954d6072125c1d152c30f8">HasName</a> () const</td></tr>
|
|
<tr class="memdesc:af6e627822f954d6072125c1d152c30f8"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the object has been named or not. <a href="#af6e627822f954d6072125c1d152c30f8">More...</a><br /></td></tr>
|
|
<tr class="separator:af6e627822f954d6072125c1d152c30f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab34671f68433c582260a443f3d15bfae"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#ab34671f68433c582260a443f3d15bfae">BaseName</a> () const</td></tr>
|
|
<tr class="memdesc:ab34671f68433c582260a443f3d15bfae"><td class="mdescLeft"> </td><td class="mdescRight">Returns a base name for automatic naming. <a href="#ab34671f68433c582260a443f3d15bfae">More...</a><br /></td></tr>
|
|
<tr class="separator:ab34671f68433c582260a443f3d15bfae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The <a class="el" href="classoperations__research_1_1PropagationBaseObject.html" title="The PropagationBaseObject is a subclass of BaseObject that is also friend to the Solver class.">PropagationBaseObject</a> is a subclass of <a class="el" href="classoperations__research_1_1BaseObject.html" title="Useful Search and Modeling Objects.">BaseObject</a> that is also friend to the <a class="el" href="classoperations__research_1_1Solver.html" title="Solver Class.">Solver</a> class. </p>
|
|
<p>It allows accessing methods useful when writing new constraints or new expressions. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03149">3149</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="afa9385e35090e310e58fc4cb6fd5d606"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa9385e35090e310e58fc4cb6fd5d606">◆ </a></span>PropagationBaseObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">operations_research::PropagationBaseObject::PropagationBaseObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classoperations__research_1_1Solver.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">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03151">3151</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a767a917fc7d9232d121994ae1e124875"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a767a917fc7d9232d121994ae1e124875">◆ </a></span>~PropagationBaseObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">operations_research::PropagationBaseObject::~PropagationBaseObject </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#l03152">3152</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="ab34671f68433c582260a443f3d15bfae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab34671f68433c582260a443f3d15bfae">◆ </a></span>BaseName()</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 operations_research::PropagationBaseObject::BaseName </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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a base name for automatic naming. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classoperations__research_1_1BooleanVar.html#af9f1ddd2359a6d10c4003822bfc81289">operations_research::BooleanVar</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae5b6f8cb73c1b76da152ad612f91c4ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae5b6f8cb73c1b76da152ad612f91c4ce">◆ </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::PropagationBaseObject::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>Reimplemented in <a class="el" href="classoperations__research_1_1Pack.html#a494cf6256ff568544390e507a6943112">operations_research::Pack</a>, <a class="el" href="classoperations__research_1_1Assignment.html#a709bad20694c9c117a3abfff24a60d03">operations_research::Assignment</a>, <a class="el" href="classoperations__research_1_1SequenceVar.html#af92814129c466409ff4c004002c2034d">operations_research::SequenceVar</a>, <a class="el" href="classoperations__research_1_1Constraint.html#a443bf6da3f8db15c240cb92d20e37466">operations_research::Constraint</a>, and <a class="el" href="classoperations__research_1_1BooleanVar.html#acad14290f1f14a53adc0feb170d67f22">operations_research::BooleanVar</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03154">3154</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5975e144479d99ceae4f009472ca5e92"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5975e144479d99ceae4f009472ca5e92">◆ </a></span>EnqueueAll()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void operations_research::PropagationBaseObject::EnqueueAll </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">SimpleRevFIFO</a>< <a class="el" href="classoperations__research_1_1Demon.html">Demon</a> * > & </td>
|
|
<td class="paramname"><em>demons</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5dd87cd906d80738f8727fda04bc5ace"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5dd87cd906d80738f8727fda04bc5ace">◆ </a></span>EnqueueDelayedDemon()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void operations_research::PropagationBaseObject::EnqueueDelayedDemon </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classoperations__research_1_1Demon.html">Demon</a> *const </td>
|
|
<td class="paramname"><em>d</em></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>This method pushes the demon onto the propagation queue. </p>
|
|
<p>It will be processed directly if the queue is empty. It will be enqueued according to its priority otherwise. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03173">3173</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3fe6115081d583d57b6cd8b0dd1783d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3fe6115081d583d57b6cd8b0dd1783d7">◆ </a></span>EnqueueVar()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void operations_research::PropagationBaseObject::EnqueueVar </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classoperations__research_1_1Demon.html">Demon</a> *const </td>
|
|
<td class="paramname"><em>d</em></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#l03174">3174</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4a7285479f5e0fa7663c043cdfc7dd61"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a7285479f5e0fa7663c043cdfc7dd61">◆ </a></span>ExecuteAll()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void operations_research::PropagationBaseObject::ExecuteAll </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">SimpleRevFIFO</a>< <a class="el" href="classoperations__research_1_1Demon.html">Demon</a> * > & </td>
|
|
<td class="paramname"><em>demons</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a78b16596f589dd63573a1586f61c2dbd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78b16596f589dd63573a1586f61c2dbd">◆ </a></span>FreezeQueue()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void operations_research::PropagationBaseObject::FreezeQueue </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>This method freezes the propagation queue. </p>
|
|
<p>It is useful when you need to apply multiple modifications at once. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03164">3164</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af6e627822f954d6072125c1d152c30f8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af6e627822f954d6072125c1d152c30f8">◆ </a></span>HasName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool operations_research::PropagationBaseObject::HasName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns whether the object has been named or not. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8be8b75223b76744791e48747677cdb6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8be8b75223b76744791e48747677cdb6">◆ </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">virtual std::string operations_research::PropagationBaseObject::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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Object naming. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad07aa613bcc8d3896dff3f33520b061c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad07aa613bcc8d3896dff3f33520b061c">◆ </a></span>reset_action_on_fail()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void operations_research::PropagationBaseObject::reset_action_on_fail </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>This method clears the failure callback. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03187">3187</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c6bf90bb0b099a2c8f81aaefdfdd46c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c6bf90bb0b099a2c8f81aaefdfdd46c">◆ </a></span>set_action_on_fail()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void operations_research::PropagationBaseObject::set_action_on_fail </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classoperations__research_1_1Solver.html#a87ca0b6abf9c8724900387f5aa557c04">Solver::Action</a> </td>
|
|
<td class="paramname"><em>a</em></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>This method sets a callback that will be called if a failure happens during the propagation of the queue. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03181">3181</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5d4a4cf402b353ba2908836656cf0c62"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d4a4cf402b353ba2908836656cf0c62">◆ </a></span>set_name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void operations_research::PropagationBaseObject::set_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d2ccb8a806df14394b3271791c81e61"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d2ccb8a806df14394b3271791c81e61">◆ </a></span>set_variable_to_clean_on_fail()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void operations_research::PropagationBaseObject::set_variable_to_clean_on_fail </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classoperations__research_1_1IntVar.html">IntVar</a> * </td>
|
|
<td class="paramname"><em>v</em></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>Shortcut for variable cleaner. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03190">3190</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab3aa61657c74294f198a16d1dbc52580"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab3aa61657c74294f198a16d1dbc52580">◆ </a></span>solver()</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_1Solver.html">Solver</a>* operations_research::PropagationBaseObject::solver </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03161">3161</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a97782b79fbcf8043201fefaa7729dcf1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97782b79fbcf8043201fefaa7729dcf1">◆ </a></span>UnfreezeQueue()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void operations_research::PropagationBaseObject::UnfreezeQueue </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>This method unfreezes the propagation queue. </p>
|
|
<p>All modifications that happened when the queue was frozen will be processed. </p>
|
|
|
|
<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>
|
|
<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 id="footer-container">
|
|
<div id="footer">
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|