Files
ortools-clone/docs/cpp_sat/classoperations__research_1_1SharedTimeLimit.html
Corentin Le Molgat 56440d30e5 Update docs to v7.5
2020-01-27 13:48:26 +01:00

310 lines
14 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: CP-SAT</h1>
</div>
<!-- Generated by Doxygen 1.8.18 -->
<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_1SharedTimeLimit.html">SharedTimeLimit</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_1SharedTimeLimit-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SharedTimeLimit</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00340">340</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.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:ab93548508ad14a5cecdaafa67db47cd9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SharedTimeLimit.html#ab93548508ad14a5cecdaafa67db47cd9">SharedTimeLimit</a> (<a class="el" href="classoperations__research_1_1TimeLimit.html">TimeLimit</a> *time_limit)</td></tr>
<tr class="separator:ab93548508ad14a5cecdaafa67db47cd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac814f11492bfc0b561c58bf951e1b031"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SharedTimeLimit.html#ac814f11492bfc0b561c58bf951e1b031">~SharedTimeLimit</a> ()</td></tr>
<tr class="separator:ac814f11492bfc0b561c58bf951e1b031"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad837e6231722ead53bbaf1c6e8f66032"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SharedTimeLimit.html#ad837e6231722ead53bbaf1c6e8f66032">LimitReached</a> () const</td></tr>
<tr class="separator:ad837e6231722ead53bbaf1c6e8f66032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17a237457e57625296e6b24feb19c60a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SharedTimeLimit.html#a17a237457e57625296e6b24feb19c60a">Stop</a> ()</td></tr>
<tr class="separator:a17a237457e57625296e6b24feb19c60a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d37e6e18c64cbaef0e3a118aeb351da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SharedTimeLimit.html#a3d37e6e18c64cbaef0e3a118aeb351da">UpdateLocalLimit</a> (<a class="el" href="classoperations__research_1_1TimeLimit.html">TimeLimit</a> *local_limit)</td></tr>
<tr class="separator:a3d37e6e18c64cbaef0e3a118aeb351da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af90cfd1fc238433fc303ee28c5914eb9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SharedTimeLimit.html#af90cfd1fc238433fc303ee28c5914eb9">AdvanceDeterministicTime</a> (double deterministic_duration)</td></tr>
<tr class="separator:af90cfd1fc238433fc303ee28c5914eb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4273b83b06bfbf856393db6d0a9b8715"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SharedTimeLimit.html#a4273b83b06bfbf856393db6d0a9b8715">GetTimeLeft</a> () const</td></tr>
<tr class="separator:a4273b83b06bfbf856393db6d0a9b8715"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7e861414a70fc937d18bc7ca743fc98"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SharedTimeLimit.html#ac7e861414a70fc937d18bc7ca743fc98">GetElapsedDeterministicTime</a> () const</td></tr>
<tr class="separator:ac7e861414a70fc937d18bc7ca743fc98"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab93548508ad14a5cecdaafa67db47cd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab93548508ad14a5cecdaafa67db47cd9">&#9670;&nbsp;</a></span>SharedTimeLimit()</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_1SharedTimeLimit.html">SharedTimeLimit</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1TimeLimit.html">TimeLimit</a> *&#160;</td>
<td class="paramname"><em>time_limit</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="time__limit_8h_source.html#l00342">342</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
</div>
</div>
<a id="ac814f11492bfc0b561c58bf951e1b031"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac814f11492bfc0b561c58bf951e1b031">&#9670;&nbsp;</a></span>~SharedTimeLimit()</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_1SharedTimeLimit.html">SharedTimeLimit</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00352">352</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af90cfd1fc238433fc303ee28c5914eb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af90cfd1fc238433fc303ee28c5914eb9">&#9670;&nbsp;</a></span>AdvanceDeterministicTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AdvanceDeterministicTime </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>deterministic_duration</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00375">375</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
</div>
</div>
<a id="ac7e861414a70fc937d18bc7ca743fc98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7e861414a70fc937d18bc7ca743fc98">&#9670;&nbsp;</a></span>GetElapsedDeterministicTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double GetElapsedDeterministicTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00385">385</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
</div>
</div>
<a id="a4273b83b06bfbf856393db6d0a9b8715"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4273b83b06bfbf856393db6d0a9b8715">&#9670;&nbsp;</a></span>GetTimeLeft()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double GetTimeLeft </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00380">380</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
</div>
</div>
<a id="ad837e6231722ead53bbaf1c6e8f66032"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad837e6231722ead53bbaf1c6e8f66032">&#9670;&nbsp;</a></span>LimitReached()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool LimitReached </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00358">358</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
</div>
</div>
<a id="a17a237457e57625296e6b24feb19c60a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17a237457e57625296e6b24feb19c60a">&#9670;&nbsp;</a></span>Stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00365">365</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
</div>
</div>
<a id="a3d37e6e18c64cbaef0e3a118aeb351da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d37e6e18c64cbaef0e3a118aeb351da">&#9670;&nbsp;</a></span>UpdateLocalLimit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void UpdateLocalLimit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1TimeLimit.html">TimeLimit</a> *&#160;</td>
<td class="paramname"><em>local_limit</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00370">370</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="time__limit_8h_source.html">time_limit.h</a></li>
</ul>
</div><!-- contents -->
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>