always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
f87f82e1bfd1e005dfd90b2c43229dbd21425f85
ortools-clone/docs/cpp_routing/classoperations__research_1_1CallMethod3.html

341 lines
17 KiB
HTML
Raw Normal View History

add more C++ doc
2019-06-13 15:36:14 +02:00
<!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"/>-->
update doc; use nice css
2019-06-20 23:08:48 +02:00
<link rel="stylesheet" type="text/css" href="ortools.css" title="default" media="screen,print" />
add more C++ doc
2019-06-13 15:36:14 +02:00
<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">
bump version to 7.2; regenerate doc
2019-06-29 18:18:08 +02:00
<span id="sfml">OR-Tools 7.2</span>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
bump version to 7.2; regenerate doc
2019-06-29 18:18:08 +02:00
<link rel="icon" href="https://developers.google.com/optimization/images/orLogo.png">
add more C++ doc
2019-06-13 15:36:14 +02:00
<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>
more linear doc
2019-07-15 17:42:24 -07:00
<li><a href="files.html"><span>Files</span></a></li>
add more C++ doc
2019-06-13 15:36:14 +02:00
</ul>
</div>
polish cpp doc
2019-07-12 13:25:23 -07:00
</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">
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
polish cpp doc
2019-07-12 13:25:23 -07:00
<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_1CallMethod3.html','');});
/* @license-end */
</script>
<div id="doc-content">
add more C++ doc
2019-06-13 15:36:14 +02:00
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classoperations__research_1_1CallMethod3-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">operations_research::CallMethod3&lt; T, P, Q, R &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
polish cpp doc
2019-07-12 13:25:23 -07:00
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class T, class P, class Q, class R&gt;<br />
class operations_research::CallMethod3&lt; T, P, Q, R &gt;</h3>
add more C++ doc
2019-06-13 15:36:14 +02:00
polish cpp doc
2019-07-12 13:25:23 -07:00
<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 three arguments. </p>
add more C++ doc
2019-06-13 15:36:14 +02:00
polish cpp doc
2019-07-12 13:25:23 -07:00
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00620">620</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
</div><table class="memberdecls">
add more C++ doc
2019-06-13 15:36:14 +02:00
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7bb7c2f91ea3952b404a6f0a0ba52e90"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1CallMethod3.html#a7bb7c2f91ea3952b404a6f0a0ba52e90">CallMethod3</a> (T *const ct, void(T::*method)(P, Q, R), const std::string &amp;name, P param1, Q param2, R param3)</td></tr>
<tr class="separator:a7bb7c2f91ea3952b404a6f0a0ba52e90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02df126ffb5bc00e01cdb0a5fd13ff12"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1CallMethod3.html#a02df126ffb5bc00e01cdb0a5fd13ff12">~CallMethod3</a> () override</td></tr>
<tr class="separator:a02df126ffb5bc00e01cdb0a5fd13ff12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a259efc51f0c4cda1c584c295309efd8a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1CallMethod3.html#a259efc51f0c4cda1c584c295309efd8a">Run</a> (<a class="el" href="classoperations__research_1_1Solver.html">Solver</a> *const s) override</td></tr>
<tr class="memdesc:a259efc51f0c4cda1c584c295309efd8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the main callback of the demon. <a href="#a259efc51f0c4cda1c584c295309efd8a">More...</a><br /></td></tr>
<tr class="separator:a259efc51f0c4cda1c584c295309efd8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ffd455d49414f28011382cf83fff175"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1CallMethod3.html#a8ffd455d49414f28011382cf83fff175">DebugString</a> () const override</td></tr>
<tr class="separator:a8ffd455d49414f28011382cf83fff175"><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>
polish cpp doc
2019-07-12 13:25:23 -07:00
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
add more C++ doc
2019-06-13 15:36:14 +02:00
<a id="a7bb7c2f91ea3952b404a6f0a0ba52e90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bb7c2f91ea3952b404a6f0a0ba52e90">&#9670;&nbsp;</a></span>CallMethod3()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class P , class Q , class R &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1CallMethod3.html">operations_research::CallMethod3</a>&lt; T, P, Q, R &gt;::<a class="el" href="classoperations__research_1_1CallMethod3.html">CallMethod3</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::*)(P, Q, R)&#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>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">P&#160;</td>
<td class="paramname"><em>param1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Q&#160;</td>
<td class="paramname"><em>param2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">R&#160;</td>
<td class="paramname"><em>param3</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">
doxygen tags for the cp/routing headers; update doc; remove filter from cpp_doxy
2019-07-05 00:25:55 +02:00
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00622">622</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
<a id="a02df126ffb5bc00e01cdb0a5fd13ff12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02df126ffb5bc00e01cdb0a5fd13ff12">&#9670;&nbsp;</a></span>~CallMethod3()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class P , class Q , class R &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1CallMethod3.html">operations_research::CallMethod3</a>&lt; T, P, Q, R &gt;::~<a class="el" href="classoperations__research_1_1CallMethod3.html">CallMethod3</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">
doxygen tags for the cp/routing headers; update doc; remove filter from cpp_doxy
2019-07-05 00:25:55 +02:00
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00631">631</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8ffd455d49414f28011382cf83fff175"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ffd455d49414f28011382cf83fff175">&#9670;&nbsp;</a></span>DebugString()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class P , class Q , class R &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_1CallMethod3.html">operations_research::CallMethod3</a>&lt; T, P, Q, R &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>
doxygen tags for the cp/routing headers; update doc; remove filter from cpp_doxy
2019-07-05 00:25:55 +02:00
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00637">637</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
add more C++ doc
2019-06-13 15:36:14 +02:00
</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="a259efc51f0c4cda1c584c295309efd8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a259efc51f0c4cda1c584c295309efd8a">&#9670;&nbsp;</a></span>Run()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class P , class Q , class R &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_1CallMethod3.html">operations_research::CallMethod3</a>&lt; T, P, Q, R &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>
doxygen tags for the cp/routing headers; update doc; remove filter from cpp_doxy
2019-07-05 00:25:55 +02:00
<p class="definition">Definition at line <a class="el" href="constraint__solveri_8h_source.html#l00633">633</a> of file <a class="el" href="constraint__solveri_8h_source.html">constraint_solveri.h</a>.</p>
add more C++ doc
2019-06-13 15:36:14 +02:00
</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 -->
polish cpp doc
2019-07-12 13:25:23 -07:00
</div><!-- doc-content -->
add more C++ doc
2019-06-13 15:36:14 +02:00
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink