Files
ortools-clone/docs/cpp_routing/classoperations__research_1_1Constraint.html
Laurent Perron 0ac3fa17eb more linear doc
2019-07-15 17:42:24 -07: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">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_1Constraint.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_1Constraint-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">operations_research::Constraint 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 constraint is the main modeling object. </p>
<p>It provides two methods:</p><ul>
<li><a class="el" href="classoperations__research_1_1Constraint.html#aaa882d58b5fc0f2e3df6eff957ad4a0d" 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#a64ab23714e57db311ba5b9fe1e742979" 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#l03521">3521</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:ae4bce2b10b1b0b3f953e356e6a34f339"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Constraint.html#ae4bce2b10b1b0b3f953e356e6a34f339">Constraint</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const <a class="el" href="classoperations__research_1_1PropagationBaseObject.html#ab3aa61657c74294f198a16d1dbc52580">solver</a>)</td></tr>
<tr class="separator:ae4bce2b10b1b0b3f953e356e6a34f339"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade8518fb88221d449c6a89f1dc7eac44"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Constraint.html#ade8518fb88221d449c6a89f1dc7eac44">~Constraint</a> () override</td></tr>
<tr class="separator:ade8518fb88221d449c6a89f1dc7eac44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa882d58b5fc0f2e3df6eff957ad4a0d"><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#aaa882d58b5fc0f2e3df6eff957ad4a0d">Post</a> ()=0</td></tr>
<tr class="memdesc:aaa882d58b5fc0f2e3df6eff957ad4a0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called when the constraint is processed by the solver. <a href="#aaa882d58b5fc0f2e3df6eff957ad4a0d">More...</a><br /></td></tr>
<tr class="separator:aaa882d58b5fc0f2e3df6eff957ad4a0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64ab23714e57db311ba5b9fe1e742979"><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#a64ab23714e57db311ba5b9fe1e742979">InitialPropagate</a> ()=0</td></tr>
<tr class="memdesc:a64ab23714e57db311ba5b9fe1e742979"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method performs the initial propagation of the constraint. <a href="#a64ab23714e57db311ba5b9fe1e742979">More...</a><br /></td></tr>
<tr class="separator:a64ab23714e57db311ba5b9fe1e742979"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a443bf6da3f8db15c240cb92d20e37466"><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#a443bf6da3f8db15c240cb92d20e37466">DebugString</a> () const override</td></tr>
<tr class="separator:a443bf6da3f8db15c240cb92d20e37466"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92c3bfe86238b5c95448d4a0384a327f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Constraint.html#a92c3bfe86238b5c95448d4a0384a327f">PostAndPropagate</a> ()</td></tr>
<tr class="memdesc:a92c3bfe86238b5c95448d4a0384a327f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calls Post and then Propagate to initialize the constraints. <a href="#a92c3bfe86238b5c95448d4a0384a327f">More...</a><br /></td></tr>
<tr class="separator:a92c3bfe86238b5c95448d4a0384a327f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e3070956af148d6fa0491de1d3cf289"><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#a6e3070956af148d6fa0491de1d3cf289">Accept</a> (<a class="el" href="classoperations__research_1_1ModelVisitor.html">ModelVisitor</a> *const visitor) const</td></tr>
<tr class="memdesc:a6e3070956af148d6fa0491de1d3cf289"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accepts the given visitor. <a href="#a6e3070956af148d6fa0491de1d3cf289">More...</a><br /></td></tr>
<tr class="separator:a6e3070956af148d6fa0491de1d3cf289"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a834edc2ae995b866a6aa63e44c242570"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Constraint.html#a834edc2ae995b866a6aa63e44c242570">IsCastConstraint</a> () const</td></tr>
<tr class="memdesc:a834edc2ae995b866a6aa63e44c242570"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the constraint created by a cast from expression to integer variable? <a href="#a834edc2ae995b866a6aa63e44c242570">More...</a><br /></td></tr>
<tr class="separator:a834edc2ae995b866a6aa63e44c242570"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5606cc31756a1708615d492ab75ba886"><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#a5606cc31756a1708615d492ab75ba886">Var</a> ()</td></tr>
<tr class="memdesc:a5606cc31756a1708615d492ab75ba886"><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="#a5606cc31756a1708615d492ab75ba886">More...</a><br /></td></tr>
<tr class="separator:a5606cc31756a1708615d492ab75ba886"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3aa61657c74294f198a16d1dbc52580"><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#ab3aa61657c74294f198a16d1dbc52580">solver</a> () const</td></tr>
<tr class="separator:ab3aa61657c74294f198a16d1dbc52580"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78b16596f589dd63573a1586f61c2dbd"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a97782b79fbcf8043201fefaa7729dcf1"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a5dd87cd906d80738f8727fda04bc5ace"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a3fe6115081d583d57b6cd8b0dd1783d7"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<tr class="memitem:a4a7285479f5e0fa7663c043cdfc7dd61"><td class="memItemLeft" align="right" valign="top">void&#160;</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>&lt; <a class="el" href="classoperations__research_1_1Demon.html">Demon</a> * &gt; &amp;demons)</td></tr>
<tr class="separator:a4a7285479f5e0fa7663c043cdfc7dd61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5975e144479d99ceae4f009472ca5e92"><td class="memItemLeft" align="right" valign="top">void&#160;</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>&lt; <a class="el" href="classoperations__research_1_1Demon.html">Demon</a> * &gt; &amp;demons)</td></tr>
<tr class="separator:a5975e144479d99ceae4f009472ca5e92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c6bf90bb0b099a2c8f81aaefdfdd46c"><td class="memItemLeft" align="right" valign="top">void&#160;</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="separator:a5c6bf90bb0b099a2c8f81aaefdfdd46c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad07aa613bcc8d3896dff3f33520b061c"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a4d2ccb8a806df14394b3271791c81e61"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a8be8b75223b76744791e48747677cdb6"><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#a8be8b75223b76744791e48747677cdb6">name</a> () const</td></tr>
<tr class="memdesc:a8be8b75223b76744791e48747677cdb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Object naming. <a href="#a8be8b75223b76744791e48747677cdb6">More...</a><br /></td></tr>
<tr class="separator:a8be8b75223b76744791e48747677cdb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d4a4cf402b353ba2908836656cf0c62"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a5d4a4cf402b353ba2908836656cf0c62">set_name</a> (const std::string &amp;<a class="el" href="classoperations__research_1_1PropagationBaseObject.html#a8be8b75223b76744791e48747677cdb6">name</a>)</td></tr>
<tr class="separator:a5d4a4cf402b353ba2908836656cf0c62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6e627822f954d6072125c1d152c30f8"><td class="memItemLeft" align="right" valign="top">bool&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:ab34671f68433c582260a443f3d15bfae"><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#ab34671f68433c582260a443f3d15bfae">BaseName</a> () const</td></tr>
<tr class="memdesc:ab34671f68433c582260a443f3d15bfae"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae4bce2b10b1b0b3f953e356e6a34f339"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4bce2b10b1b0b3f953e356e6a34f339">&#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">operations_research::Constraint::Constraint </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#l03523">3523</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="ade8518fb88221d449c6a89f1dc7eac44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade8518fb88221d449c6a89f1dc7eac44">&#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">operations_research::Constraint::~Constraint </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#l03524">3524</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="a6e3070956af148d6fa0491de1d3cf289"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e3070956af148d6fa0491de1d3cf289">&#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::Constraint::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#ad7fda9d44f000fcb907d2bdeec845423">operations_research::Pack</a>.</p>
</div>
</div>
<a id="ab34671f68433c582260a443f3d15bfae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab34671f68433c582260a443f3d15bfae">&#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 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 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#af9f1ddd2359a6d10c4003822bfc81289">operations_research::BooleanVar</a>.</p>
</div>
</div>
<a id="a443bf6da3f8db15c240cb92d20e37466"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a443bf6da3f8db15c240cb92d20e37466">&#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::Constraint::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#ae5b6f8cb73c1b76da152ad612f91c4ce">operations_research::PropagationBaseObject</a>.</p>
<p>Reimplemented in <a class="el" href="classoperations__research_1_1Pack.html#a494cf6256ff568544390e507a6943112">operations_research::Pack</a>.</p>
</div>
</div>
<a id="a5975e144479d99ceae4f009472ca5e92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5975e144479d99ceae4f009472ca5e92">&#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 operations_research::PropagationBaseObject::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="a5dd87cd906d80738f8727fda04bc5ace"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5dd87cd906d80738f8727fda04bc5ace">&#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 operations_research::PropagationBaseObject::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#l03129">3129</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">&#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 operations_research::PropagationBaseObject::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#l03130">3130</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">&#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 operations_research::PropagationBaseObject::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="a78b16596f589dd63573a1586f61c2dbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78b16596f589dd63573a1586f61c2dbd">&#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 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 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#l03120">3120</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">&#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 operations_research::PropagationBaseObject::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="a64ab23714e57db311ba5b9fe1e742979"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64ab23714e57db311ba5b9fe1e742979">&#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 operations_research::Constraint::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#adac62b65b527aa23434dd7d1fdba3b14">operations_research::Pack</a>, <a class="el" href="classoperations__research_1_1TypeRegulationsConstraint.html#a350eb7ba99ec672599956a2b61a2a8b1">operations_research::TypeRegulationsConstraint</a>, and <a class="el" href="classoperations__research_1_1GlobalVehicleBreaksConstraint.html#a8e1a06d00ced8b302406376235cd2c98">operations_research::GlobalVehicleBreaksConstraint</a>.</p>
</div>
</div>
<a id="a834edc2ae995b866a6aa63e44c242570"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a834edc2ae995b866a6aa63e44c242570">&#9670;&nbsp;</a></span>IsCastConstraint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operations_research::Constraint::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="a8be8b75223b76744791e48747677cdb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8be8b75223b76744791e48747677cdb6">&#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 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 class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Object naming. </p>
</div>
</div>
<a id="aaa882d58b5fc0f2e3df6eff957ad4a0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa882d58b5fc0f2e3df6eff957ad4a0d">&#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 operations_research::Constraint::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#a22f97f40518e3d2f565d78f7ef6f3b56">operations_research::Pack</a>, <a class="el" href="classoperations__research_1_1TypeRegulationsConstraint.html#add0fa8d777cd68c77f87cfbd22ad5dd9">operations_research::TypeRegulationsConstraint</a>, and <a class="el" href="classoperations__research_1_1GlobalVehicleBreaksConstraint.html#a9228a638a979284394f90c004a1b37fa">operations_research::GlobalVehicleBreaksConstraint</a>.</p>
</div>
</div>
<a id="a92c3bfe86238b5c95448d4a0384a327f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92c3bfe86238b5c95448d4a0384a327f">&#9670;&nbsp;</a></span>PostAndPropagate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void operations_research::Constraint::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="ad07aa613bcc8d3896dff3f33520b061c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad07aa613bcc8d3896dff3f33520b061c">&#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 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 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#l03143">3143</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">&#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 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>&#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#l03137">3137</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">&#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 operations_research::PropagationBaseObject::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="a4d2ccb8a806df14394b3271791c81e61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d2ccb8a806df14394b3271791c81e61">&#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 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> *&#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#l03146">3146</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">&#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>* 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 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#l03116">3116</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">&#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 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 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#l03124">3124</a> of file <a class="el" href="constraint__solver_8h_source.html">constraint_solver.h</a>.</p>
</div>
</div>
<a id="a5606cc31756a1708615d492ab75ba886"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5606cc31756a1708615d492ab75ba886">&#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>* operations_research::Constraint::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><!-- doc-content -->
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>