Files
ortools-clone/docs/cpp_routing/classoperations__research_1_1Constraint.html
Corentin Le Molgat b670dc9daa Update doc
2020-04-23 15:34:43 +02:00

775 lines
40 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">Google OR-Tools 7.5</span>
</div>
</div>
<div id="content" style="width: 100%; overflow: hidden;">
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
<h2>C++ Reference</h2>
<ul>
<li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
<li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
<li><a href="../cpp_graph/annotated.html">Graph</a></li>
<li><a href="../cpp_routing/annotated.html">Routing</a></li>
<li><a href="../cpp_linear/annotated.html">Linear solver</a></li>
</ul>
</div>
<div id="content">
<div align="center">
<h1 style="color: #145A32;">C++ Reference: Routing</h1>
</div>
<!-- Generated by Doxygen 1.8.16 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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="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_1Constraint.html">Constraint</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classoperations__research_1_1Constraint-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Constraint<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 constraint is the main modeling object. </p>
<p>It provides two methods:</p><ul>
<li><a class="el" href="classoperations__research_1_1Constraint.html#af33bad3aa81a2f411224d5e471f9956f" title="This method is called when the constraint is processed by the solver.">Post()</a> is responsible for creating the demons and attaching them to immediate demons().</li>
<li><a class="el" href="classoperations__research_1_1Constraint.html#a9100fab5545234f60a4ce442dbb45630" title="This method performs the initial propagation of the constraint.">InitialPropagate()</a> is called once just after Post and performs the initial propagation. The subsequent propagations will be performed by the demons Posted during the post() method. </li>
</ul>
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03536">3536</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:ad73d074eabf60c009e7ca6a16a5909e4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Constraint.html#ad73d074eabf60c009e7ca6a16a5909e4">Constraint</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const <a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a5f32c22c620c811754ba7b6f977db864">solver</a>)</td></tr>
<tr class="separator:ad73d074eabf60c009e7ca6a16a5909e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06a1a88fd005ae10834c7fcfa4bc8d20"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Constraint.html#a06a1a88fd005ae10834c7fcfa4bc8d20">~Constraint</a> () override</td></tr>
<tr class="separator:a06a1a88fd005ae10834c7fcfa4bc8d20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af33bad3aa81a2f411224d5e471f9956f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Constraint.html#af33bad3aa81a2f411224d5e471f9956f">Post</a> ()=0</td></tr>
<tr class="memdesc:af33bad3aa81a2f411224d5e471f9956f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called when the constraint is processed by the solver. <a href="classoperations__research_1_1Constraint.html#af33bad3aa81a2f411224d5e471f9956f">More...</a><br /></td></tr>
<tr class="separator:af33bad3aa81a2f411224d5e471f9956f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9100fab5545234f60a4ce442dbb45630"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Constraint.html#a9100fab5545234f60a4ce442dbb45630">InitialPropagate</a> ()=0</td></tr>
<tr class="memdesc:a9100fab5545234f60a4ce442dbb45630"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method performs the initial propagation of the constraint. <a href="classoperations__research_1_1Constraint.html#a9100fab5545234f60a4ce442dbb45630">More...</a><br /></td></tr>
<tr class="separator:a9100fab5545234f60a4ce442dbb45630"><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_1Constraint.html#aed804747c45a7e1caf81461f9e45dd91">DebugString</a> () const override</td></tr>
<tr class="separator:aed804747c45a7e1caf81461f9e45dd91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19c44e0b2911b809a9403701804088e3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Constraint.html#a19c44e0b2911b809a9403701804088e3">PostAndPropagate</a> ()</td></tr>
<tr class="memdesc:a19c44e0b2911b809a9403701804088e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calls Post and then Propagate to initialize the constraints. <a href="classoperations__research_1_1Constraint.html#a19c44e0b2911b809a9403701804088e3">More...</a><br /></td></tr>
<tr class="separator:a19c44e0b2911b809a9403701804088e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcde421cf076575a27bed81c80093ac8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Constraint.html#afcde421cf076575a27bed81c80093ac8">Accept</a> (<a class="el" href="classoperations__research_1_1ModelVisitor.html">ModelVisitor</a> *const visitor) const</td></tr>
<tr class="memdesc:afcde421cf076575a27bed81c80093ac8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accepts the given visitor. <a href="classoperations__research_1_1Constraint.html#afcde421cf076575a27bed81c80093ac8">More...</a><br /></td></tr>
<tr class="separator:afcde421cf076575a27bed81c80093ac8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a573284ea4ace994b6886c6a4feffa0aa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Constraint.html#a573284ea4ace994b6886c6a4feffa0aa">IsCastConstraint</a> () const</td></tr>
<tr class="memdesc:a573284ea4ace994b6886c6a4feffa0aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the constraint created by a cast from expression to integer variable? <a href="classoperations__research_1_1Constraint.html#a573284ea4ace994b6886c6a4feffa0aa">More...</a><br /></td></tr>
<tr class="separator:a573284ea4ace994b6886c6a4feffa0aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acde5e7966f7772bf931dd0dd2bc398a1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classoperations__research_1_1IntVar.html">IntVar</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Constraint.html#acde5e7966f7772bf931dd0dd2bc398a1">Var</a> ()</td></tr>
<tr class="memdesc:acde5e7966f7772bf931dd0dd2bc398a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a Boolean variable representing the status of the constraint (false = constraint is violated, true = constraint is satisfied). <a href="classoperations__research_1_1Constraint.html#acde5e7966f7772bf931dd0dd2bc398a1">More...</a><br /></td></tr>
<tr class="separator:acde5e7966f7772bf931dd0dd2bc398a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f32c22c620c811754ba7b6f977db864"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a5f32c22c620c811754ba7b6f977db864">solver</a> () const</td></tr>
<tr class="separator:a5f32c22c620c811754ba7b6f977db864"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5155ff01cf80f5a478fd09916abab155"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a5155ff01cf80f5a478fd09916abab155">FreezeQueue</a> ()</td></tr>
<tr class="memdesc:a5155ff01cf80f5a478fd09916abab155"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method freezes the propagation queue. <a href="classoperations__research_1_1PropagationBaseObject.html#a5155ff01cf80f5a478fd09916abab155">More...</a><br /></td></tr>
<tr class="separator:a5155ff01cf80f5a478fd09916abab155"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae038f4a9249362629fc47e8dfc441ec7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#ae038f4a9249362629fc47e8dfc441ec7">UnfreezeQueue</a> ()</td></tr>
<tr class="memdesc:ae038f4a9249362629fc47e8dfc441ec7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method unfreezes the propagation queue. <a href="classoperations__research_1_1PropagationBaseObject.html#ae038f4a9249362629fc47e8dfc441ec7">More...</a><br /></td></tr>
<tr class="separator:ae038f4a9249362629fc47e8dfc441ec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a173cbf153462b14f9b57362d2c45638a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a173cbf153462b14f9b57362d2c45638a">EnqueueDelayedDemon</a> (<a class="el" href="classoperations__research_1_1Demon.html">Demon</a> *const d)</td></tr>
<tr class="memdesc:a173cbf153462b14f9b57362d2c45638a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method pushes the demon onto the propagation queue. <a href="classoperations__research_1_1PropagationBaseObject.html#a173cbf153462b14f9b57362d2c45638a">More...</a><br /></td></tr>
<tr class="separator:a173cbf153462b14f9b57362d2c45638a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a448b9bde901fcf3ec2e94ab972b083f0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a448b9bde901fcf3ec2e94ab972b083f0">EnqueueVar</a> (<a class="el" href="classoperations__research_1_1Demon.html">Demon</a> *const d)</td></tr>
<tr class="separator:a448b9bde901fcf3ec2e94ab972b083f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d3bd9d99cf43cf184a1246d2c278c31"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a3d3bd9d99cf43cf184a1246d2c278c31">ExecuteAll</a> (const <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">SimpleRevFIFO</a>&lt; <a class="el" href="classoperations__research_1_1Demon.html">Demon</a> * &gt; &amp;demons)</td></tr>
<tr class="separator:a3d3bd9d99cf43cf184a1246d2c278c31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a5ad1a2482043e4a9d2c19bbab1e250"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a5a5ad1a2482043e4a9d2c19bbab1e250">EnqueueAll</a> (const <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">SimpleRevFIFO</a>&lt; <a class="el" href="classoperations__research_1_1Demon.html">Demon</a> * &gt; &amp;demons)</td></tr>
<tr class="separator:a5a5ad1a2482043e4a9d2c19bbab1e250"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ae4667b0e7a9e6c63c91202480c8876"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a3ae4667b0e7a9e6c63c91202480c8876">set_action_on_fail</a> (<a class="el" href="classoperations__research_1_1Solver.html#ad7946514ee3dd6cb3ab993dc9e98b33b">Solver::Action</a> a)</td></tr>
<tr class="separator:a3ae4667b0e7a9e6c63c91202480c8876"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26d87b428f06d54a1a44d6e950a0e196"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a26d87b428f06d54a1a44d6e950a0e196">reset_action_on_fail</a> ()</td></tr>
<tr class="memdesc:a26d87b428f06d54a1a44d6e950a0e196"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method clears the failure callback. <a href="classoperations__research_1_1PropagationBaseObject.html#a26d87b428f06d54a1a44d6e950a0e196">More...</a><br /></td></tr>
<tr class="separator:a26d87b428f06d54a1a44d6e950a0e196"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa799a452245f03cc53355e6432c107a7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#aa799a452245f03cc53355e6432c107a7">set_variable_to_clean_on_fail</a> (<a class="el" href="classoperations__research_1_1IntVar.html">IntVar</a> *v)</td></tr>
<tr class="memdesc:aa799a452245f03cc53355e6432c107a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shortcut for variable cleaner. <a href="classoperations__research_1_1PropagationBaseObject.html#aa799a452245f03cc53355e6432c107a7">More...</a><br /></td></tr>
<tr class="separator:aa799a452245f03cc53355e6432c107a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a119daa8b83c3aaffdb6e11fac1f97e"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a6a119daa8b83c3aaffdb6e11fac1f97e">name</a> () const</td></tr>
<tr class="memdesc:a6a119daa8b83c3aaffdb6e11fac1f97e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Object naming. <a href="classoperations__research_1_1PropagationBaseObject.html#a6a119daa8b83c3aaffdb6e11fac1f97e">More...</a><br /></td></tr>
<tr class="separator:a6a119daa8b83c3aaffdb6e11fac1f97e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5260b9627048b854b45d05ed34adc22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#ad5260b9627048b854b45d05ed34adc22">set_name</a> (const std::string &amp;<a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a6a119daa8b83c3aaffdb6e11fac1f97e">name</a>)</td></tr>
<tr class="separator:ad5260b9627048b854b45d05ed34adc22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31eda3918c04e32fa9e8c432d72b2d60"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a31eda3918c04e32fa9e8c432d72b2d60">HasName</a> () const</td></tr>
<tr class="memdesc:a31eda3918c04e32fa9e8c432d72b2d60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the object has been named or not. <a href="classoperations__research_1_1PropagationBaseObject.html#a31eda3918c04e32fa9e8c432d72b2d60">More...</a><br /></td></tr>
<tr class="separator:a31eda3918c04e32fa9e8c432d72b2d60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09cbe240b742fbdcf4d3c70d19c2ed10"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a09cbe240b742fbdcf4d3c70d19c2ed10">BaseName</a> () const</td></tr>
<tr class="memdesc:a09cbe240b742fbdcf4d3c70d19c2ed10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a base name for automatic naming. <a href="classoperations__research_1_1PropagationBaseObject.html#a09cbe240b742fbdcf4d3c70d19c2ed10">More...</a><br /></td></tr>
<tr class="separator:a09cbe240b742fbdcf4d3c70d19c2ed10"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad73d074eabf60c009e7ca6a16a5909e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad73d074eabf60c009e7ca6a16a5909e4">&#9670;&nbsp;</a></span>Constraint()</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_1Constraint.html">Constraint</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const&#160;</td>
<td class="paramname"><em>solver</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#l03538">3538</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="a06a1a88fd005ae10834c7fcfa4bc8d20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06a1a88fd005ae10834c7fcfa4bc8d20">&#9670;&nbsp;</a></span>~Constraint()</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_1Constraint.html">Constraint</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#l03539">3539</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="afcde421cf076575a27bed81c80093ac8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcde421cf076575a27bed81c80093ac8">&#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 Accept </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1ModelVisitor.html">ModelVisitor</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="classoperations__research_1_1Pack.html#aa30c84aec5e60d6b74e1e1eb15011d4a">Pack</a>.</p>
</div>
</div>
<a id="a09cbe240b742fbdcf4d3c70d19c2ed10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09cbe240b742fbdcf4d3c70d19c2ed10">&#9670;&nbsp;</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 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 class="mlabel">inherited</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#adbfe3c73b9cad61f112ccb082b553c51">BooleanVar</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">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_1PropagationBaseObject.html#aed804747c45a7e1caf81461f9e45dd91">PropagationBaseObject</a>.</p>
<p>Reimplemented in <a class="el" href="classoperations__research_1_1Pack.html#aed804747c45a7e1caf81461f9e45dd91">Pack</a>, and <a class="el" href="classoperations__research_1_1GlobalVehicleBreaksConstraint.html#aed804747c45a7e1caf81461f9e45dd91">GlobalVehicleBreaksConstraint</a>.</p>
</div>
</div>
<a id="a5a5ad1a2482043e4a9d2c19bbab1e250"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a5ad1a2482043e4a9d2c19bbab1e250">&#9670;&nbsp;</a></span>EnqueueAll()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void EnqueueAll </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">SimpleRevFIFO</a>&lt; <a class="el" href="classoperations__research_1_1Demon.html">Demon</a> * &gt; &amp;&#160;</td>
<td class="paramname"><em>demons</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a173cbf153462b14f9b57362d2c45638a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a173cbf153462b14f9b57362d2c45638a">&#9670;&nbsp;</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 EnqueueDelayedDemon </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Demon.html">Demon</a> *const&#160;</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 class="mlabel">inherited</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#l03144">3144</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="a448b9bde901fcf3ec2e94ab972b083f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a448b9bde901fcf3ec2e94ab972b083f0">&#9670;&nbsp;</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 EnqueueVar </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Demon.html">Demon</a> *const&#160;</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 class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03145">3145</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="a3d3bd9d99cf43cf184a1246d2c278c31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d3bd9d99cf43cf184a1246d2c278c31">&#9670;&nbsp;</a></span>ExecuteAll()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ExecuteAll </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classoperations__research_1_1SimpleRevFIFO.html">SimpleRevFIFO</a>&lt; <a class="el" href="classoperations__research_1_1Demon.html">Demon</a> * &gt; &amp;&#160;</td>
<td class="paramname"><em>demons</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5155ff01cf80f5a478fd09916abab155"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5155ff01cf80f5a478fd09916abab155">&#9670;&nbsp;</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 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 class="mlabel">inherited</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#l03135">3135</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="a31eda3918c04e32fa9e8c432d72b2d60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31eda3918c04e32fa9e8c432d72b2d60">&#9670;&nbsp;</a></span>HasName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool HasName </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">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether the object has been named or not. </p>
</div>
</div>
<a id="a9100fab5545234f60a4ce442dbb45630"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9100fab5545234f60a4ce442dbb45630">&#9670;&nbsp;</a></span>InitialPropagate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void InitialPropagate </td>
<td>(</td>
<td class="paramname"></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>This method performs the initial propagation of the constraint. </p>
<p>It is called just after the post. </p>
<p>Implemented in <a class="el" href="classoperations__research_1_1Pack.html#a36d844f2722273b190ed9a069dd25938">Pack</a>, <a class="el" href="classoperations__research_1_1TypeRegulationsConstraint.html#a36d844f2722273b190ed9a069dd25938">TypeRegulationsConstraint</a>, and <a class="el" href="classoperations__research_1_1GlobalVehicleBreaksConstraint.html#a36d844f2722273b190ed9a069dd25938">GlobalVehicleBreaksConstraint</a>.</p>
</div>
</div>
<a id="a573284ea4ace994b6886c6a4feffa0aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a573284ea4ace994b6886c6a4feffa0aa">&#9670;&nbsp;</a></span>IsCastConstraint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IsCastConstraint </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Is the constraint created by a cast from expression to integer variable? </p>
</div>
</div>
<a id="a6a119daa8b83c3aaffdb6e11fac1f97e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a119daa8b83c3aaffdb6e11fac1f97e">&#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">virtual std::string 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 class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Object naming. </p>
</div>
</div>
<a id="af33bad3aa81a2f411224d5e471f9956f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af33bad3aa81a2f411224d5e471f9956f">&#9670;&nbsp;</a></span>Post()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Post </td>
<td>(</td>
<td class="paramname"></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>This method is called when the constraint is processed by the solver. </p>
<p>Its main usage is to attach demons to variables. </p>
<p>Implemented in <a class="el" href="classoperations__research_1_1Pack.html#a19d94d32f3bde30deeebb883c6f71f84">Pack</a>, <a class="el" href="classoperations__research_1_1TypeRegulationsConstraint.html#a19d94d32f3bde30deeebb883c6f71f84">TypeRegulationsConstraint</a>, and <a class="el" href="classoperations__research_1_1GlobalVehicleBreaksConstraint.html#a19d94d32f3bde30deeebb883c6f71f84">GlobalVehicleBreaksConstraint</a>.</p>
</div>
</div>
<a id="a19c44e0b2911b809a9403701804088e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19c44e0b2911b809a9403701804088e3">&#9670;&nbsp;</a></span>PostAndPropagate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PostAndPropagate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calls Post and then Propagate to initialize the constraints. </p>
<p>This is usually done in the root node. </p>
</div>
</div>
<a id="a26d87b428f06d54a1a44d6e950a0e196"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26d87b428f06d54a1a44d6e950a0e196">&#9670;&nbsp;</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 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 class="mlabel">inherited</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#l03158">3158</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="a3ae4667b0e7a9e6c63c91202480c8876"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ae4667b0e7a9e6c63c91202480c8876">&#9670;&nbsp;</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 set_action_on_fail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Solver.html#ad7946514ee3dd6cb3ab993dc9e98b33b">Solver::Action</a>&#160;</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 class="mlabel">inherited</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>
<a id="ad5260b9627048b854b45d05ed34adc22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5260b9627048b854b45d05ed34adc22">&#9670;&nbsp;</a></span>set_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void set_name </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa799a452245f03cc53355e6432c107a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa799a452245f03cc53355e6432c107a7">&#9670;&nbsp;</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 set_variable_to_clean_on_fail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1IntVar.html">IntVar</a> *&#160;</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 class="mlabel">inherited</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#l03161">3161</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="a5f32c22c620c811754ba7b6f977db864"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f32c22c620c811754ba7b6f977db864">&#9670;&nbsp;</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>* 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 class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="constraint__solver_8h_source.html#l03131">3131</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="ae038f4a9249362629fc47e8dfc441ec7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae038f4a9249362629fc47e8dfc441ec7">&#9670;&nbsp;</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 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 class="mlabel">inherited</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#l03139">3139</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="acde5e7966f7772bf931dd0dd2bc398a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acde5e7966f7772bf931dd0dd2bc398a1">&#9670;&nbsp;</a></span>Var()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classoperations__research_1_1IntVar.html">IntVar</a>* Var </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>Creates a Boolean variable representing the status of the constraint (false = constraint is violated, true = constraint is satisfied). </p>
<p>It returns nullptr if the constraint does not support this API. </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>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>