always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
b5acca4bcbcd092ba767abc4620a2a026ab68e46
ortools-clone/docs/cpp/classoperations__research_1_1_time_limit.html

997 lines
60 KiB
HTML
Raw Normal View History

Update generated doc
2020-09-01 16:00:33 +02:00
<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
regenerate docs
2022-01-17 21:42:14 +01:00
<meta name="generator" content="Doxygen 1.9.3"/>
Update generated doc
2020-09-01 16:00:33 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: TimeLimit</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="styleSheet.tmp.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="orLogo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
Update doc
2022-03-04 00:11:33 +01:00
&#160;<span id="projectnumber">9.3</span>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
regenerate docs
2022-01-17 21:42:14 +01:00
<!-- Generated by Doxygen 1.9.3 -->
Update generated doc
2020-09-01 16:00:33 +02:00
<script type="text/javascript">
regenerate docs
2022-01-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
Update generated doc
2020-09-01 16:00:33 +02:00
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
regenerate docs
2022-01-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
Update generated doc
2020-09-01 16:00:33 +02:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
regenerate docs
2022-01-17 21:42:14 +01:00
/* @license-end */
</script>
Update generated doc
2020-09-01 16:00:33 +02:00
<div id="main-nav"></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">
regenerate docs
2022-01-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classoperations__research_1_1_time_limit.html',''); initResizable(); });
Update generated doc
2020-09-01 16:00:33 +02:00
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
Update doc
2020-10-09 12:00:09 +02:00
<a href="classoperations__research_1_1_time_limit-members.html">List of all members</a> </div>
regenerate docs
2022-01-17 21:42:14 +01:00
<div class="headertitle"><div class="title">TimeLimit</div></div>
Update generated doc
2020-09-01 16:00:33 +02:00
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
regenerate docs
2022-01-17 21:42:14 +01:00
<div class="textblock"><p >A simple class to enforce both an elapsed time limit and a deterministic time limit in the same thread as a program. </p>
<p >The idea is to call <a class="el" href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca" title="Returns true when the external limit is true, or the deterministic time is over the deterministic lim...">LimitReached()</a> as often as possible, until it returns false. The program should then abort as fast as possible.</p>
<p >The deterministic limit is used to ensure reproductibility. As a consequence the deterministic time has to be advanced manually using the method <a class="el" href="classoperations__research_1_1_time_limit.html#af90cfd1fc238433fc303ee28c5914eb9" title="Advances the deterministic time.">AdvanceDeterministicTime()</a>.</p>
<p >The instruction counter keeps track of number of executed cpu instructions. It uses Performance Monitoring Unit (PMU) counters to keep track of instruction count.</p>
<p >The call itself is as fast as CycleClock::Now() + a few trivial instructions, unless the time_limit_use_instruction_count flag is set.</p>
<p >The limit is very conservative: it returns true (i.e. the limit is reached) when current_time + max(T, ε) &gt;= limit_time, where ε is a small constant (see <a class="el" href="classoperations__research_1_1_time_limit.html#a1837453fa693143e6ec334701557a448">TimeLimit::kSafetyBufferSeconds</a>), and T is the maximum measured time interval between two consecutive calls to <a class="el" href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca" title="Returns true when the external limit is true, or the deterministic time is over the deterministic lim...">LimitReached()</a> over the last kHistorySize calls (so that we only consider "recent" history). This is made so that the probability of actually exceeding the time limit is small, without aborting too early.</p>
<p >The deterministic time limit can be logged at a more granular level: the method <a class="el" href="classoperations__research_1_1_time_limit.html#af90cfd1fc238433fc303ee28c5914eb9" title="Advances the deterministic time.">TimeLimit::AdvanceDeterministicTime</a> takes an optional string argument: the name of a counter. In debug mode, the time limit object computes also the elapsed time for each named counter separately, and these values can be used to determine the coefficients for computing the deterministic duration from the number of operations. The values of the counters can be printed using <a class="el" href="classoperations__research_1_1_time_limit.html#a764be64f3029f8b8e23511061d8de355" title="Returns information about the time limit object in a human-readable form.">TimeLimit::DebugString()</a>. There is no API to access the values of the counters directly, because they do not exist in optimized mode.</p>
<p >The basic steps for determining coefficients for the deterministic time are:</p><ol type="1">
Update generated doc
2020-09-01 16:00:33 +02:00
<li>Run the code in debug mode to collect the values of the deterministic time counters. Unless the algorithm is different in optimized mode, the values of the deterministic counters in debug mode will be the same as in optimized mode.</li>
<li>Run the code in optimized mode to measure the real (CPU) time of the whole benchmark.</li>
<li>Determine the coefficients for deterministic time from the real time and the values of the deterministic counters, e. g. by solving the equations C_1*c_1 + C_2*c_2 + ... + C_N*c_N + Err = T where C_1 is the unknown coefficient for counter c_1, Err is the random measurement error and T is the measured real time. The equation can be solved e.g. using the least squares method.</li>
</ol>
regenerate docs
2022-01-17 21:42:14 +01:00
<p >Note that in optimized mode, the counters are disabled for performance reasons, and calling AdvanceDeterministicTime(duration, counter_name) is equivalent to calling AdvanceDeterministicTime(duration). </p>
Update generated doc
2020-09-01 16:00:33 +02:00
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00106">106</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div><table class="memberdecls">
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
Public Member Functions</h2></td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:aa0975c0aa18ee607a54e7c4c8986ff0f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#aa0975c0aa18ee607a54e7c4c8986ff0f">TimeLimit</a> (double limit_in_seconds, double deterministic_limit=std::numeric_limits&lt; double &gt;::infinity(), double instruction_limit=std::numeric_limits&lt; double &gt;::infinity())</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:aa0975c0aa18ee607a54e7c4c8986ff0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the elapsed, the deterministic time and the instruction count limits. <a href="classoperations__research_1_1_time_limit.html#aa0975c0aa18ee607a54e7c4c8986ff0f">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:aa0975c0aa18ee607a54e7c4c8986ff0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:a0598aaf87dab140f870c8ada2a1f3a39"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a0598aaf87dab140f870c8ada2a1f3a39">TimeLimit</a> ()</td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:a0598aaf87dab140f870c8ada2a1f3a39"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:ac056854a98f4094ef4c8d3858b955fef"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#ac056854a98f4094ef4c8d3858b955fef">TimeLimit</a> (const <a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> &amp;)=delete</td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:ac056854a98f4094ef4c8d3858b955fef"><td class="memSeparator" colspan="2">&#160;</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memitem:ad184e7d5cf6d68a6d9b2d32c8dc30c06"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#ad184e7d5cf6d68a6d9b2d32c8dc30c06">operator=</a> (const <a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> &amp;)=delete</td></tr>
<tr class="separator:ad184e7d5cf6d68a6d9b2d32c8dc30c06"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:a43229b9a540c5b4c3751ebb13e73ace8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a43229b9a540c5b4c3751ebb13e73ace8">SetInstructionLimit</a> (double instruction_limit)</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:a43229b9a540c5b4c3751ebb13e73ace8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the instruction limit. <a href="classoperations__research_1_1_time_limit.html#a43229b9a540c5b4c3751ebb13e73ace8">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:a43229b9a540c5b4c3751ebb13e73ace8"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:a4cb3517d59bf4642a85294267736af20"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a4cb3517d59bf4642a85294267736af20">ReadInstructionCounter</a> ()</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:a4cb3517d59bf4642a85294267736af20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of instructions executed since the creation of this object. <a href="classoperations__research_1_1_time_limit.html#a4cb3517d59bf4642a85294267736af20">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:a4cb3517d59bf4642a85294267736af20"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:a810d5f7aaf80cc09cf5a094e20c1aaca"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca">LimitReached</a> ()</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:a810d5f7aaf80cc09cf5a094e20c1aaca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true when the external limit is true, or the deterministic time is over the deterministic limit or if the next time <code><a class="el" href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca" title="Returns true when the external limit is true, or the deterministic time is over the deterministic lim...">LimitReached()</a></code> is called is likely to be over the time limit. <a href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:a810d5f7aaf80cc09cf5a094e20c1aaca"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<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_1_time_limit.html#a4273b83b06bfbf856393db6d0a9b8715">GetTimeLeft</a> () const</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:a4273b83b06bfbf856393db6d0a9b8715"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the time left on this limit, or 0 if the limit was reached (it never returns a negative value). <a href="classoperations__research_1_1_time_limit.html#a4273b83b06bfbf856393db6d0a9b8715">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:a4273b83b06bfbf856393db6d0a9b8715"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:a362a88bfe50d83c028154a62ef53e780"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a362a88bfe50d83c028154a62ef53e780">GetDeterministicTimeLeft</a> () const</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:a362a88bfe50d83c028154a62ef53e780"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the remaining deterministic time before <code><a class="el" href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca" title="Returns true when the external limit is true, or the deterministic time is over the deterministic lim...">LimitReached()</a></code> returns true due to the deterministic limit. <a href="classoperations__research_1_1_time_limit.html#a362a88bfe50d83c028154a62ef53e780">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:a362a88bfe50d83c028154a62ef53e780"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:a0be73bea3d751ca2926c1cd616abb31e"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a0be73bea3d751ca2926c1cd616abb31e">GetInstructionsLeft</a> ()</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:a0be73bea3d751ca2926c1cd616abb31e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of instructions left to reach the limit. <a href="classoperations__research_1_1_time_limit.html#a0be73bea3d751ca2926c1cd616abb31e">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:a0be73bea3d751ca2926c1cd616abb31e"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<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_1_time_limit.html#af90cfd1fc238433fc303ee28c5914eb9">AdvanceDeterministicTime</a> (double deterministic_duration)</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:af90cfd1fc238433fc303ee28c5914eb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advances the deterministic time. <a href="classoperations__research_1_1_time_limit.html#af90cfd1fc238433fc303ee28c5914eb9">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:af90cfd1fc238433fc303ee28c5914eb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:ad068edb54c705c548c20e4ba47b4e3a8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#ad068edb54c705c548c20e4ba47b4e3a8">AdvanceDeterministicTime</a> (double deterministic_duration, const char *counter_name)</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:ad068edb54c705c548c20e4ba47b4e3a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advances the deterministic time. <a href="classoperations__research_1_1_time_limit.html#ad068edb54c705c548c20e4ba47b4e3a8">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:ad068edb54c705c548c20e4ba47b4e3a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:ae3fe2e2b613455b49c6cc74dd3c7581e"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#ae3fe2e2b613455b49c6cc74dd3c7581e">GetElapsedTime</a> () const</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:ae3fe2e2b613455b49c6cc74dd3c7581e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the time elapsed in seconds since the construction of this object. <a href="classoperations__research_1_1_time_limit.html#ae3fe2e2b613455b49c6cc74dd3c7581e">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:ae3fe2e2b613455b49c6cc74dd3c7581e"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<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_1_time_limit.html#ac7e861414a70fc937d18bc7ca743fc98">GetElapsedDeterministicTime</a> () const</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:ac7e861414a70fc937d18bc7ca743fc98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the elapsed deterministic time since the construction of this object. <a href="classoperations__research_1_1_time_limit.html#ac7e861414a70fc937d18bc7ca743fc98">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:ac7e861414a70fc937d18bc7ca743fc98"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:a5b6cf15a55615535aa54e71103de8d9f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a5b6cf15a55615535aa54e71103de8d9f">RegisterExternalBooleanAsLimit</a> (std::atomic&lt; bool &gt; *external_boolean_as_limit)</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:a5b6cf15a55615535aa54e71103de8d9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers the external Boolean to check when <a class="el" href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca" title="Returns true when the external limit is true, or the deterministic time is over the deterministic lim...">LimitReached()</a> is called. <a href="classoperations__research_1_1_time_limit.html#a5b6cf15a55615535aa54e71103de8d9f">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:a5b6cf15a55615535aa54e71103de8d9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memitem:a4747b1676f59ae0ccca60bb4c414de08"><td class="memItemLeft" align="right" valign="top">std::atomic&lt; bool &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a4747b1676f59ae0ccca60bb4c414de08">ExternalBooleanAsLimit</a> () const</td></tr>
<tr class="memdesc:a4747b1676f59ae0ccca60bb4c414de08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current external Boolean limit. <a href="classoperations__research_1_1_time_limit.html#a4747b1676f59ae0ccca60bb4c414de08">More...</a><br /></td></tr>
<tr class="separator:a4747b1676f59ae0ccca60bb4c414de08"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="memitem:a312550ebabce586fb77c49e813c610f8"><td class="memTemplParams" colspan="2">template&lt;typename Parameters &gt; </td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:a312550ebabce586fb77c49e813c610f8"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a312550ebabce586fb77c49e813c610f8">ResetLimitFromParameters</a> (const Parameters &amp;<a class="el" href="cp__model__fz__solver_8cc.html#a10a1eab179b472c030bdc2a2efef7219">parameters</a>)</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:a312550ebabce586fb77c49e813c610f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets new time limits. <a href="classoperations__research_1_1_time_limit.html#a312550ebabce586fb77c49e813c610f8">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:a312550ebabce586fb77c49e813c610f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:ad0cdf04d71ac4f14262eb4871041ddbd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#ad0cdf04d71ac4f14262eb4871041ddbd">MergeWithGlobalTimeLimit</a> (<a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> *other)</td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:ad0cdf04d71ac4f14262eb4871041ddbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2022-03-04 00:11:33 +01:00
<tr class="memitem:af6b375b546e563ed7e6312123ce9c7a0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#af6b375b546e563ed7e6312123ce9c7a0">ChangeDeterministicLimit</a> (double new_limit)</td></tr>
<tr class="memdesc:af6b375b546e563ed7e6312123ce9c7a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overwrites the deterministic time limit with the new value. <a href="classoperations__research_1_1_time_limit.html#af6b375b546e563ed7e6312123ce9c7a0">More...</a><br /></td></tr>
<tr class="separator:af6b375b546e563ed7e6312123ce9c7a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75214ecbf18d3e29566c78cac35f699b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a75214ecbf18d3e29566c78cac35f699b">GetDeterministicLimit</a> () const</td></tr>
<tr class="memdesc:a75214ecbf18d3e29566c78cac35f699b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queries the deterministic time limit. <a href="classoperations__research_1_1_time_limit.html#a75214ecbf18d3e29566c78cac35f699b">More...</a><br /></td></tr>
<tr class="separator:a75214ecbf18d3e29566c78cac35f699b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:a764be64f3029f8b8e23511061d8de355"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a764be64f3029f8b8e23511061d8de355">DebugString</a> () const</td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memdesc:a764be64f3029f8b8e23511061d8de355"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns information about the time limit object in a human-readable form. <a href="classoperations__research_1_1_time_limit.html#a764be64f3029f8b8e23511061d8de355">More...</a><br /></td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:a764be64f3029f8b8e23511061d8de355"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
Static Public Member Functions</h2></td></tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="memitem:a8e8e386d8f916b1fefb983118cbdf0a6"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr&lt; <a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a8e8e386d8f916b1fefb983118cbdf0a6">Infinite</a> ()</td></tr>
<tr class="memdesc:a8e8e386d8f916b1fefb983118cbdf0a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a time limit object that uses infinite time for wall time, deterministic time and instruction count limit. <a href="classoperations__research_1_1_time_limit.html#a8e8e386d8f916b1fefb983118cbdf0a6">More...</a><br /></td></tr>
<tr class="separator:a8e8e386d8f916b1fefb983118cbdf0a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a905ec35ba16ac082d3528cf4b6ea9658"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr&lt; <a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a905ec35ba16ac082d3528cf4b6ea9658">FromDeterministicTime</a> (double deterministic_limit)</td></tr>
<tr class="memdesc:a905ec35ba16ac082d3528cf4b6ea9658"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a time limit object that puts limit only on the deterministic time. <a href="classoperations__research_1_1_time_limit.html#a905ec35ba16ac082d3528cf4b6ea9658">More...</a><br /></td></tr>
<tr class="separator:a905ec35ba16ac082d3528cf4b6ea9658"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ea9620e492bd75ea7e2fcded8f1de8b"><td class="memTemplParams" colspan="2">template&lt;typename Parameters &gt; </td></tr>
<tr class="memitem:a0ea9620e492bd75ea7e2fcded8f1de8b"><td class="memTemplItemLeft" align="right" valign="top">static std::unique_ptr&lt; <a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a0ea9620e492bd75ea7e2fcded8f1de8b">FromParameters</a> (const Parameters &amp;<a class="el" href="cp__model__fz__solver_8cc.html#a10a1eab179b472c030bdc2a2efef7219">parameters</a>)</td></tr>
<tr class="memdesc:a0ea9620e492bd75ea7e2fcded8f1de8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a time limit object initialized from an object that provides methods <code>max_time_in_seconds()</code> and max_deterministic_time(). <a href="classoperations__research_1_1_time_limit.html#a0ea9620e492bd75ea7e2fcded8f1de8b">More...</a><br /></td></tr>
<tr class="separator:a0ea9620e492bd75ea7e2fcded8f1de8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
</table><table class="memberdecls">
regenerate docs
2022-01-17 21:42:14 +01:00
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
Static Public Attributes</h2></td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:a1837453fa693143e6ec334701557a448"><td class="memItemLeft" align="right" valign="top">static const double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#a1837453fa693143e6ec334701557a448">kSafetyBufferSeconds</a> = 1e-4</td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:a1837453fa693143e6ec334701557a448"><td class="memSeparator" colspan="2">&#160;</td></tr>
Update doc
2020-10-09 12:00:09 +02:00
<tr class="memitem:ac62fbbc5383a86a9fe334e3213f6244b"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_time_limit.html#ac62fbbc5383a86a9fe334e3213f6244b">kHistorySize</a> = 100</td></tr>
Update generated doc
2020-09-01 16:00:33 +02:00
<tr class="separator:ac62fbbc5383a86a9fe334e3213f6244b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="aa0975c0aa18ee607a54e7c4c8986ff0f" name="aa0975c0aa18ee607a54e7c4c8986ff0f"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#aa0975c0aa18ee607a54e7c4c8986ff0f">&#9670;&nbsp;</a></span>TimeLimit() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
Update doc
2020-10-09 12:00:09 +02:00
<td class="memname"><a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> </td>
Update generated doc
2020-09-01 16:00:33 +02:00
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>limit_in_seconds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>deterministic_limit</em> = <code>std::numeric_limits&lt;double&gt;::infinity()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>instruction_limit</em> = <code>std::numeric_limits&lt;double&gt;::infinity()</code>&#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 class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the elapsed, the deterministic time and the instruction count limits. </p>
regenerate docs
2022-01-17 21:42:14 +01:00
<p >The elapsed time is based on the wall time and the counter starts 'now'. The deterministic time has to be manually advanced using the method <a class="el" href="classoperations__research_1_1_time_limit.html#af90cfd1fc238433fc303ee28c5914eb9" title="Advances the deterministic time.">AdvanceDeterministicTime()</a>.</p>
<p >Instruction count is the number of instructions executed. It is based on PMU counters and is not very acurate.</p>
<p >Use an infinite limit value to ignore a limit. </p>
Update generated doc
2020-09-01 16:00:33 +02:00
Update doc
2022-03-04 00:11:33 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00485">485</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a0598aaf87dab140f870c8ada2a1f3a39" name="a0598aaf87dab140f870c8ada2a1f3a39"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a0598aaf87dab140f870c8ada2a1f3a39">&#9670;&nbsp;</a></span>TimeLimit() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
Update doc
2020-10-09 12:00:09 +02:00
<td class="memname"><a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> </td>
Update generated doc
2020-09-01 16:00:33 +02:00
<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">
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00127">127</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="ac056854a98f4094ef4c8d3858b955fef" name="ac056854a98f4094ef4c8d3858b955fef"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#ac056854a98f4094ef4c8d3858b955fef">&#9670;&nbsp;</a></span>TimeLimit() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
Update doc
2020-10-09 12:00:09 +02:00
<td class="memname"><a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> </td>
Update generated doc
2020-09-01 16:00:33 +02:00
<td>(</td>
Update doc
2020-10-09 12:00:09 +02:00
<td class="paramtype">const <a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> &amp;&#160;</td>
Update generated doc
2020-09-01 16:00:33 +02:00
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="af90cfd1fc238433fc303ee28c5914eb9" name="af90cfd1fc238433fc303ee28c5914eb9"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#af90cfd1fc238433fc303ee28c5914eb9">&#9670;&nbsp;</a></span>AdvanceDeterministicTime() <span class="overload">[1/2]</span></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>Advances the deterministic time. </p>
regenerate docs
2022-01-17 21:42:14 +01:00
<p >For reproducibility reasons, the deterministic time doesn't advance automatically as the regular elapsed time does. </p>
Update generated doc
2020-09-01 16:00:33 +02:00
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00227">227</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="ad068edb54c705c548c20e4ba47b4e3a8" name="ad068edb54c705c548c20e4ba47b4e3a8"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#ad068edb54c705c548c20e4ba47b4e3a8">&#9670;&nbsp;</a></span>AdvanceDeterministicTime() <span class="overload">[2/2]</span></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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>counter_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>Advances the deterministic time. </p>
regenerate docs
2022-01-17 21:42:14 +01:00
<p >For reproducibility reasons, the deterministic time doesn't advance automatically as the regular elapsed time does.</p>
<p >In debug mode, this method also updates the deterministic time counter with the given name. In optimized mode, this method is equivalent to <code><a class="el" href="classoperations__research_1_1_time_limit.html#af90cfd1fc238433fc303ee28c5914eb9" title="Advances the deterministic time.">AdvanceDeterministicTime(double)</a></code>. </p>
Update generated doc
2020-09-01 16:00:33 +02:00
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00241">241</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
Update doc
2022-03-04 00:11:33 +01:00
</div>
</div>
<a id="af6b375b546e563ed7e6312123ce9c7a0" name="af6b375b546e563ed7e6312123ce9c7a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6b375b546e563ed7e6312123ce9c7a0">&#9670;&nbsp;</a></span>ChangeDeterministicLimit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ChangeDeterministicLimit </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>new_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>Overwrites the deterministic time limit with the new value. </p>
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00297">297</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a764be64f3029f8b8e23511061d8de355" name="a764be64f3029f8b8e23511061d8de355"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a764be64f3029f8b8e23511061d8de355">&#9670;&nbsp;</a></span>DebugString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string DebugString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns information about the time limit object in a human-readable form. </p>
<p class="definition">Definition at line <a class="el" href="time__limit_8cc_source.html#l00031">31</a> of file <a class="el" href="time__limit_8cc_source.html">time_limit.cc</a>.</p>
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a4747b1676f59ae0ccca60bb4c414de08" name="a4747b1676f59ae0ccca60bb4c414de08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4747b1676f59ae0ccca60bb4c414de08">&#9670;&nbsp;</a></span>ExternalBooleanAsLimit()</h2>
Update generated doc
2020-09-01 16:00:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<td class="memname">std::atomic&lt; bool &gt; * ExternalBooleanAsLimit </td>
Update generated doc
2020-09-01 16:00:33 +02:00
<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>Returns the current external Boolean limit. </p>
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00282">282</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a905ec35ba16ac082d3528cf4b6ea9658" name="a905ec35ba16ac082d3528cf4b6ea9658"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a905ec35ba16ac082d3528cf4b6ea9658">&#9670;&nbsp;</a></span>FromDeterministicTime()</h2>
Update generated doc
2020-09-01 16:00:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<td class="memname">static std::unique_ptr&lt; <a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> &gt; FromDeterministicTime </td>
Update generated doc
2020-09-01 16:00:33 +02:00
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>deterministic_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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a time limit object that puts limit only on the deterministic time. </p>
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00145">145</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a0ea9620e492bd75ea7e2fcded8f1de8b" name="a0ea9620e492bd75ea7e2fcded8f1de8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ea9620e492bd75ea7e2fcded8f1de8b">&#9670;&nbsp;</a></span>FromParameters()</h2>
Update generated doc
2020-09-01 16:00:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<td class="memname">static std::unique_ptr&lt; <a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> &gt; FromParameters </td>
Update generated doc
2020-09-01 16:00:33 +02:00
<td>(</td>
<td class="paramtype">const Parameters &amp;&#160;</td>
<td class="paramname"><em>parameters</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a time limit object initialized from an object that provides methods <code>max_time_in_seconds()</code> and max_deterministic_time(). </p>
regenerate docs
2022-01-17 21:42:14 +01:00
<p >This method is designed specifically to work with solver parameter protos, e.g. <code>BopParameters</code>, <code>MipParameters</code> and <code>SatParameters</code>. </p>
Update generated doc
2020-09-01 16:00:33 +02:00
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00160">160</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
Update doc
2022-03-04 00:11:33 +01:00
</div>
</div>
<a id="a75214ecbf18d3e29566c78cac35f699b" name="a75214ecbf18d3e29566c78cac35f699b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75214ecbf18d3e29566c78cac35f699b">&#9670;&nbsp;</a></span>GetDeterministicLimit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double GetDeterministicLimit </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>Queries the deterministic time limit. </p>
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00304">304</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a362a88bfe50d83c028154a62ef53e780" name="a362a88bfe50d83c028154a62ef53e780"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a362a88bfe50d83c028154a62ef53e780">&#9670;&nbsp;</a></span>GetDeterministicTimeLeft()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double GetDeterministicTimeLeft </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">
Update doc
2020-10-09 12:00:09 +02:00
<p>Returns the remaining deterministic time before <code><a class="el" href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca" title="Returns true when the external limit is true, or the deterministic time is over the deterministic lim...">LimitReached()</a></code> returns true due to the deterministic limit. </p>
regenerate docs
2022-01-17 21:42:14 +01:00
<p >If the <code><a class="el" href="classoperations__research_1_1_time_limit.html" title="A simple class to enforce both an elapsed time limit and a deterministic time limit in the same threa...">TimeLimit</a></code> was constructed with <b>infinity</b> as the deterministic limit (default value), this will always return infinity. </p>
Update generated doc
2020-09-01 16:00:33 +02:00
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00213">213</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="ac7e861414a70fc937d18bc7ca743fc98" name="ac7e861414a70fc937d18bc7ca743fc98"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<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>Returns the elapsed deterministic time since the construction of this object. </p>
regenerate docs
2022-01-17 21:42:14 +01:00
<p >That corresponds to the sum of all deterministic durations passed as an argument to <code><a class="el" href="classoperations__research_1_1_time_limit.html#af90cfd1fc238433fc303ee28c5914eb9" title="Advances the deterministic time.">AdvanceDeterministicTime()</a></code> calls. </p>
Update generated doc
2020-09-01 16:00:33 +02:00
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00261">261</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="ae3fe2e2b613455b49c6cc74dd3c7581e" name="ae3fe2e2b613455b49c6cc74dd3c7581e"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#ae3fe2e2b613455b49c6cc74dd3c7581e">&#9670;&nbsp;</a></span>GetElapsedTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double GetElapsedTime </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>Returns the time elapsed in seconds since the construction of this object. </p>
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00252">252</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a0be73bea3d751ca2926c1cd616abb31e" name="a0be73bea3d751ca2926c1cd616abb31e"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a0be73bea3d751ca2926c1cd616abb31e">&#9670;&nbsp;</a></span>GetInstructionsLeft()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double GetInstructionsLeft </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>Returns the number of instructions left to reach the limit. </p>
Update doc
2022-03-04 00:11:33 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00595">595</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a4273b83b06bfbf856393db6d0a9b8715" name="a4273b83b06bfbf856393db6d0a9b8715"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<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>Returns the time left on this limit, or 0 if the limit was reached (it never returns a negative value). </p>
regenerate docs
2022-01-17 21:42:14 +01:00
<p >Note that it might return a positive value even though <code><a class="el" href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca" title="Returns true when the external limit is true, or the deterministic time is over the deterministic lim...">LimitReached()</a></code> would return true; because the latter is conservative (see toplevel comment). If <code><a class="el" href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca" title="Returns true when the external limit is true, or the deterministic time is over the deterministic lim...">LimitReached()</a></code> was actually called and did return <b>true</b>, though, this will always return 0.</p>
<p >If the <a class="el" href="classoperations__research_1_1_time_limit.html" title="A simple class to enforce both an elapsed time limit and a deterministic time limit in the same threa...">TimeLimit</a> was constructed with <b>infinity</b> as the limit, this will always return infinity.</p>
<p >Note that this function is not optimized for speed as <code><a class="el" href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca" title="Returns true when the external limit is true, or the deterministic time is over the deterministic lim...">LimitReached()</a></code> is. </p>
Update generated doc
2020-09-01 16:00:33 +02:00
Update doc
2022-03-04 00:11:33 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00584">584</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a8e8e386d8f916b1fefb983118cbdf0a6" name="a8e8e386d8f916b1fefb983118cbdf0a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e8e386d8f916b1fefb983118cbdf0a6">&#9670;&nbsp;</a></span>Infinite()</h2>
Update generated doc
2020-09-01 16:00:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<td class="memname">static std::unique_ptr&lt; <a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> &gt; Infinite </td>
Update generated doc
2020-09-01 16:00:33 +02:00
<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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a time limit object that uses infinite time for wall time, deterministic time and instruction count limit. </p>
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00135">135</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a810d5f7aaf80cc09cf5a094e20c1aaca" name="a810d5f7aaf80cc09cf5a094e20c1aaca"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a810d5f7aaf80cc09cf5a094e20c1aaca">&#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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
Update doc
2020-10-09 12:00:09 +02:00
<p>Returns true when the external limit is true, or the deterministic time is over the deterministic limit or if the next time <code><a class="el" href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca" title="Returns true when the external limit is true, or the deterministic time is over the deterministic lim...">LimitReached()</a></code> is called is likely to be over the time limit. </p>
regenerate docs
2022-01-17 21:42:14 +01:00
<p >See toplevel comment. Once it has returned true, it is guaranteed to always return true. </p>
Update generated doc
2020-09-01 16:00:33 +02:00
Update doc
2022-03-04 00:11:33 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00546">546</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="ad0cdf04d71ac4f14262eb4871041ddbd" name="ad0cdf04d71ac4f14262eb4871041ddbd"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#ad0cdf04d71ac4f14262eb4871041ddbd">&#9670;&nbsp;</a></span>MergeWithGlobalTimeLimit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MergeWithGlobalTimeLimit </td>
<td>(</td>
Update doc
2020-10-09 12:00:09 +02:00
<td class="paramtype"><a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> *&#160;</td>
Update generated doc
2020-09-01 16:00:33 +02:00
<td class="paramname"><em>other</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">
Update doc
2022-03-04 00:11:33 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00525">525</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="ad184e7d5cf6d68a6d9b2d32c8dc30c06" name="ad184e7d5cf6d68a6d9b2d32c8dc30c06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad184e7d5cf6d68a6d9b2d32c8dc30c06">&#9670;&nbsp;</a></span>operator=()</h2>
Update generated doc
2020-09-01 16:00:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
regenerate docs
2022-01-17 21:42:14 +01:00
<td class="memname"><a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> &amp; operator= </td>
Update generated doc
2020-09-01 16:00:33 +02:00
<td>(</td>
Update doc
2020-10-09 12:00:09 +02:00
<td class="paramtype">const <a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a> &amp;&#160;</td>
Update generated doc
2020-09-01 16:00:33 +02:00
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a4cb3517d59bf4642a85294267736af20" name="a4cb3517d59bf4642a85294267736af20"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a4cb3517d59bf4642a85294267736af20">&#9670;&nbsp;</a></span>ReadInstructionCounter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double ReadInstructionCounter </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>Returns the number of instructions executed since the creation of this object. </p>
Update doc
2022-03-04 00:11:33 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00536">536</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a5b6cf15a55615535aa54e71103de8d9f" name="a5b6cf15a55615535aa54e71103de8d9f"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a5b6cf15a55615535aa54e71103de8d9f">&#9670;&nbsp;</a></span>RegisterExternalBooleanAsLimit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void RegisterExternalBooleanAsLimit </td>
<td>(</td>
<td class="paramtype">std::atomic&lt; bool &gt; *&#160;</td>
<td class="paramname"><em>external_boolean_as_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">
Update doc
2020-10-09 12:00:09 +02:00
<p>Registers the external Boolean to check when <a class="el" href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca" title="Returns true when the external limit is true, or the deterministic time is over the deterministic lim...">LimitReached()</a> is called. </p>
regenerate docs
2022-01-17 21:42:14 +01:00
<p >This is used to mark the limit as reached through an external Boolean, i.e. <code><a class="el" href="classoperations__research_1_1_time_limit.html#a810d5f7aaf80cc09cf5a094e20c1aaca" title="Returns true when the external limit is true, or the deterministic time is over the deterministic lim...">LimitReached()</a></code> returns true when the value of external_boolean_as_limit is true whatever the time limits are.</p>
<p >Note that users of the <a class="el" href="classoperations__research_1_1_time_limit.html" title="A simple class to enforce both an elapsed time limit and a deterministic time limit in the same threa...">TimeLimit</a> can modify the provided atomic for their own internal logic (see <a class="el" href="classoperations__research_1_1_shared_time_limit.html#a17a237457e57625296e6b24feb19c60a">SharedTimeLimit::Stop()</a> for example). </p>
Update generated doc
2020-09-01 16:00:33 +02:00
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00274">274</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a312550ebabce586fb77c49e813c610f8" name="a312550ebabce586fb77c49e813c610f8"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a312550ebabce586fb77c49e813c610f8">&#9670;&nbsp;</a></span>ResetLimitFromParameters()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ResetLimitFromParameters </td>
<td>(</td>
<td class="paramtype">const Parameters &amp;&#160;</td>
<td class="paramname"><em>parameters</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>Sets new time limits. </p>
regenerate docs
2022-01-17 21:42:14 +01:00
<p >Note that this does not reset the running max nor any registered external Boolean. </p>
Update generated doc
2020-09-01 16:00:33 +02:00
Update doc
2022-03-04 00:11:33 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00519">519</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a43229b9a540c5b4c3751ebb13e73ace8" name="a43229b9a540c5b4c3751ebb13e73ace8"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a43229b9a540c5b4c3751ebb13e73ace8">&#9670;&nbsp;</a></span>SetInstructionLimit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SetInstructionLimit </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>instruction_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>Sets the instruction limit. </p>
regenerate docs
2022-01-17 21:42:14 +01:00
<p >We need this method since the static constructor to create time limit from parameters doesn't support setting instruction limit. </p>
Update generated doc
2020-09-01 16:00:33 +02:00
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00172">172</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="ac62fbbc5383a86a9fe334e3213f6244b" name="ac62fbbc5383a86a9fe334e3213f6244b"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#ac62fbbc5383a86a9fe334e3213f6244b">&#9670;&nbsp;</a></span>kHistorySize</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int kHistorySize = 100</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00109">109</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
regenerate docs
2022-01-17 21:42:14 +01:00
<a id="a1837453fa693143e6ec334701557a448" name="a1837453fa693143e6ec334701557a448"></a>
Update generated doc
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a1837453fa693143e6ec334701557a448">&#9670;&nbsp;</a></span>kSafetyBufferSeconds</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const double kSafetyBufferSeconds = 1e-4</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
docs: Update to v9.2
2021-12-14 13:41:01 +01:00
<p class="definition">Definition at line <a class="el" href="time__limit_8h_source.html#l00108">108</a> of file <a class="el" href="time__limit_8h_source.html">time_limit.h</a>.</p>
Update generated doc
2020-09-01 16:00:33 +02:00
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="time__limit_8h_source.html">time_limit.h</a></li>
<li><a class="el" href="time__limit_8cc_source.html">time_limit.cc</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
Update doc
2020-10-09 12:00:09 +02:00
<li class="navelem"><a class="el" href="namespaceoperations__research.html">operations_research</a></li><li class="navelem"><a class="el" href="classoperations__research_1_1_time_limit.html">TimeLimit</a></li>
Update generated doc
2020-09-01 16:00:33 +02:00
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
regenerate docs
2022-01-17 21:42:14 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.3 </li>
Update generated doc
2020-09-01 16:00:33 +02:00
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink