always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
a2f0a660e97d36e8d770c9097d8337cdcd6bbf73
ortools-clone/docs/cpp_routing/classoperations__research_1_1CallMethod0.html
Laurent Perron dd1c593370 update doc; use nice css
2019-06-20 23:08:48 +02:00

344 lines
19 KiB
HTML
Raw Blame History

<!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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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_1CallMethod0.html">CallMethod0</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_1CallMethod0-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">operations_research::CallMethod0&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classoperations__research_1_1Demon.html" title="A Demon is the base element of a propagation queue.">Demon</a> proxy to a method on the constraint with no arguments.
<a href="classoperations__research_1_1CallMethod0.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for operations_research::CallMethod0&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classoperations__research_1_1CallMethod0__inherit__graph.png" border="0" usemap="#operations__research_1_1CallMethod0_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="operations__research_1_1CallMethod0_3_01T_01_4_inherit__map" id="operations__research_1_1CallMethod0_3_01T_01_4_inherit__map">
<area shape="rect" title="Demon proxy to a method on the constraint with no arguments." alt="" coords="5,179,148,217"/>
<area shape="rect" href="classoperations__research_1_1Demon.html" title="A Demon is the base element of a propagation queue." alt="" coords="5,92,148,131"/>
<area shape="rect" href="classoperations__research_1_1BaseObject.html" title="Useful Search and Modeling Objects." alt="" coords="5,5,148,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for operations_research::CallMethod0&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classoperations__research_1_1CallMethod0__coll__graph.png" border="0" usemap="#operations__research_1_1CallMethod0_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="operations__research_1_1CallMethod0_3_01T_01_4_coll__map" id="operations__research_1_1CallMethod0_3_01T_01_4_coll__map">
<area shape="rect" title="Demon proxy to a method on the constraint with no arguments." alt="" coords="5,179,148,217"/>
<area shape="rect" href="classoperations__research_1_1Demon.html" title="A Demon is the base element of a propagation queue." alt="" coords="5,92,148,131"/>
<area shape="rect" href="classoperations__research_1_1BaseObject.html" title="Useful Search and Modeling Objects." alt="" coords="5,5,148,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:a52f89d97b033f2aaaed56b59f155e843"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1CallMethod0.html#a52f89d97b033f2aaaed56b59f155e843">CallMethod0</a> (T *const ct, void(T::*method)(), const std::string &amp;name)</td></tr>
<tr class="separator:a52f89d97b033f2aaaed56b59f155e843"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a440b83783e9b3e454da1b9ff8e0158d6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1CallMethod0.html#a440b83783e9b3e454da1b9ff8e0158d6">~CallMethod0</a> () override</td></tr>
<tr class="separator:a440b83783e9b3e454da1b9ff8e0158d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a9ae132209a5ae456616619c3a85766"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1CallMethod0.html#a1a9ae132209a5ae456616619c3a85766">Run</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const s) override</td></tr>
<tr class="memdesc:a1a9ae132209a5ae456616619c3a85766"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the main callback of the demon. <a href="#a1a9ae132209a5ae456616619c3a85766">More...</a><br /></td></tr>
<tr class="separator:a1a9ae132209a5ae456616619c3a85766"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50933bd9255294eca78f60b3b5bd176c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1CallMethod0.html#a50933bd9255294eca78f60b3b5bd176c">DebugString</a> () const override</td></tr>
<tr class="separator:a50933bd9255294eca78f60b3b5bd176c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ec8db0f9eacea36b80bfacfb1b5af8b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classoperations__research_1_1Solver.html#a4b0972c731faf884eba5acab99ebb2b4">Solver::DemonPriority</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Demon.html#a7ec8db0f9eacea36b80bfacfb1b5af8b">priority</a> () const</td></tr>
<tr class="memdesc:a7ec8db0f9eacea36b80bfacfb1b5af8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method returns the priority of the demon. <a href="#a7ec8db0f9eacea36b80bfacfb1b5af8b">More...</a><br /></td></tr>
<tr class="separator:a7ec8db0f9eacea36b80bfacfb1b5af8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e51b1b49f9a937b335cd9381f95614d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Demon.html#a4e51b1b49f9a937b335cd9381f95614d">inhibit</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const s)</td></tr>
<tr class="memdesc:a4e51b1b49f9a937b335cd9381f95614d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method inhibits the demon in the search tree below the current position. <a href="#a4e51b1b49f9a937b335cd9381f95614d">More...</a><br /></td></tr>
<tr class="separator:a4e51b1b49f9a937b335cd9381f95614d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae63a7d849eb2b518ac708c736c670f9c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Demon.html#ae63a7d849eb2b518ac708c736c670f9c">desinhibit</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const s)</td></tr>
<tr class="memdesc:ae63a7d849eb2b518ac708c736c670f9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method un-inhibits the demon that was previously inhibited. <a href="#ae63a7d849eb2b518ac708c736c670f9c">More...</a><br /></td></tr>
<tr class="separator:ae63a7d849eb2b518ac708c736c670f9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class T&gt;<br />
class operations_research::CallMethod0&lt; T &gt;</h3>
<p><a class="el" href="classoperations__research_1_1Demon.html" title="A Demon is the base element of a propagation queue.">Demon</a> proxy to a method on the constraint with no arguments. </p>
<p>These methods represent generic demons that will call back a method on the constraint during their Run method. This way, all propagation methods are members of the constraint class, and demons are just proxies with a priority of NORMAL_PRIORITY. </p>
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00518">518</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a52f89d97b033f2aaaed56b59f155e843"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52f89d97b033f2aaaed56b59f155e843">&#9670;&nbsp;</a></span>CallMethod0()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1CallMethod0.html">operations_research::CallMethod0</a>&lt; T &gt;::<a class="el" href="classoperations__research_1_1CallMethod0.html">CallMethod0</a> </td>
<td>(</td>
<td class="paramtype">T *const&#160;</td>
<td class="paramname"><em>ct</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(T::*)()&#160;</td>
<td class="paramname"><em>method</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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__solveri_8h_source.html#l00520">520</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<a id="a440b83783e9b3e454da1b9ff8e0158d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a440b83783e9b3e454da1b9ff8e0158d6">&#9670;&nbsp;</a></span>~CallMethod0()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1CallMethod0.html">operations_research::CallMethod0</a>&lt; T &gt;::~<a class="el" href="classoperations__research_1_1CallMethod0.html">CallMethod0</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__solveri_8h_source.html#l00523">523</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a50933bd9255294eca78f60b3b5bd176c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50933bd9255294eca78f60b3b5bd176c">&#9670;&nbsp;</a></span>DebugString()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classoperations__research_1_1CallMethod0.html">operations_research::CallMethod0</a>&lt; T &gt;::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_1Demon.html#a906a1bd16d33b9b841e68b2a06bbbfd2">operations_research::Demon</a>.</p>
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00527">527</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<a id="ae63a7d849eb2b518ac708c736c670f9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae63a7d849eb2b518ac708c736c670f9c">&#9670;&nbsp;</a></span>desinhibit()</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::Demon::desinhibit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method un-inhibits the demon that was previously inhibited. </p>
</div>
</div>
<a id="a4e51b1b49f9a937b335cd9381f95614d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e51b1b49f9a937b335cd9381f95614d">&#9670;&nbsp;</a></span>inhibit()</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::Demon::inhibit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method inhibits the demon in the search tree below the current position. </p>
</div>
</div>
<a id="a7ec8db0f9eacea36b80bfacfb1b5af8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ec8db0f9eacea36b80bfacfb1b5af8b">&#9670;&nbsp;</a></span>priority()</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_1Solver.html#a4b0972c731faf884eba5acab99ebb2b4">Solver::DemonPriority</a> operations_research::Demon::priority </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>This method returns the priority of the demon. </p>
<p>Usually a demon is fast, slow or normal. Immediate demons are reserved for internal use to maintain variables. </p>
<p>Reimplemented in <a class="el" href="classoperations__research_1_1DelayedCallMethod2.html#a9fd8b3e6b2008cc95f7d562659f63e12">operations_research::DelayedCallMethod2&lt; T, P, Q &gt;</a>, <a class="el" href="classoperations__research_1_1DelayedCallMethod1.html#a7ef6fa85722c1d3da524468a6f3a6347">operations_research::DelayedCallMethod1&lt; T, P &gt;</a>, and <a class="el" href="classoperations__research_1_1DelayedCallMethod0.html#adfd9001b4514cf914865ff234f189775">operations_research::DelayedCallMethod0&lt; T &gt;</a>.</p>
</div>
</div>
<a id="a1a9ae132209a5ae456616619c3a85766"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a9ae132209a5ae456616619c3a85766">&#9670;&nbsp;</a></span>Run()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classoperations__research_1_1CallMethod0.html">operations_research::CallMethod0</a>&lt; T &gt;::Run </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is the main callback of the demon. </p>
<p>Implements <a class="el" href="classoperations__research_1_1Demon.html#a7d3876bb3b369f0ae115e08ce9a6dc72">operations_research::Demon</a>.</p>
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00525">525</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a></li>
</ul>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink