270 lines
38 KiB
HTML
270 lines
38 KiB
HTML
<!-- 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"/>
|
|
<meta name="generator" content="Doxygen 1.9.3"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: solve_interrupter.h Source File</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
|
|
 <span id="projectnumber">9.3</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.3 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<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">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('solve__interrupter_8h_source.html',''); initResizable(); });
|
|
/* @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="headertitle"><div class="title">solve_interrupter.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="solve__interrupter_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2010-2021 Google LLC</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// You may obtain a copy of the License at</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// limitations under the License.</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#ifndef OR_TOOLS_MATH_OPT_CORE_SOLVE_INTERRUPTER_H_</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#define OR_TOOLS_MATH_OPT_CORE_SOLVE_INTERRUPTER_H_</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include <atomic></span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include <cstdint></span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include <functional></span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include <optional></span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include "absl/base/thread_annotations.h"</span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include "absl/strings/string_view.h"</span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include "absl/synchronization/mutex.h"</span></div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include "<a class="code" href="linked__hash__map_8h.html">ortools/base/linked_hash_map.h</a>"</span></div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include "<a class="code" href="strong__int_8h.html">ortools/base/strong_int.h</a>"</span></div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research.html">operations_research</a> {</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research_1_1math__opt.html">math_opt</a> {</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment">// Interrupter used by solvers to know if/when they should interrupt the solve.</span></div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment">// Once triggered with Interrupt(), an interrupter can't be reset. It can be</span></div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">// triggered from any thread.</span></div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">// Thread-safety: APIs on this class are safe to call concurrently from multiple</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment">// threads.</span></div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html"> 39</a></span><span class="keyword">class </span><a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html">SolveInterrupter</a> {</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// Id used to identify a callback.</span></div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#ad9f6f05a4b4ba43054d9e545cf1b3930"> 42</a></span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#ad9f6f05a4b4ba43054d9e545cf1b3930">DEFINE_STRONG_INT_TYPE</a>(CallbackId, int64_t);</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a9f4d3f1692b57758c10763bea8a50a04"> 44</a></span> <span class="keyword">using</span> <a class="code hl_typedef" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a9f4d3f1692b57758c10763bea8a50a04">Callback</a> = std::function<void()>;</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a99023201ed82f56c6ccd6646b6ae583d"> 46</a></span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a99023201ed82f56c6ccd6646b6ae583d">SolveInterrupter</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a6e2dbc96b2f157fb0bba2cef9e7607d7"> 48</a></span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a6e2dbc96b2f157fb0bba2cef9e7607d7">SolveInterrupter</a>(<span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html">SolveInterrupter</a>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a196eaec60854e829cac61e645c79b496"> 49</a></span> <a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html">SolveInterrupter</a>& <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a196eaec60854e829cac61e645c79b496">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html">SolveInterrupter</a>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// Interrupts the solve as soon as possible.</span></div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// Once requested the interruption can't be reset. The user should use a new</span></div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// SolveInterrupter for later solves.</span></div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// It is safe to call this function multiple times. Only the first call will</span></div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="comment">// have visible effects; other calls will be ignored.</span></div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#ac1c30a63fcff78de5e4924f7ee2b822e">Interrupt</a>();</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// Returns true if the solve interruption has been requested.</span></div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// This API is fast; it costs the read of an atomic.</span></div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a31cbaf141396f29d05b73b5350b29ed1"> 63</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a31cbaf141396f29d05b73b5350b29ed1">IsInterrupted</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> interrupted_.load(); }</div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// Registers a callback to be called when the interruption is requested.</span></div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// The callback is immediately called if the interrupter has already been</span></div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// triggered or if it is triggered during the registration. This is typically</span></div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// useful for a solver implementation so that it does not have to test</span></div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// IsInterrupted() to do the same thing it does in the callback. Simply</span></div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// registering the callback is enough.</span></div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// The callback function can't make calls to AddInterruptionCallback(),</span></div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// RemoveInterruptionCallback() and Interrupt(). This would result is a</span></div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// deadlock. Calling IsInterrupted() is fine though.</span></div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> CallbackId <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a911dee5bfdb399422eb33d0486ed0934">AddInterruptionCallback</a>(<a class="code hl_typedef" href="namespaceoperations__research_1_1math__opt.html#a9d73bc1014f12f33dfaa51825ad668ee">Callback</a> <a class="code hl_variable" href="gurobi__interface_8cc.html#a6627a3800ac768bb5528ef54c9cace36">callback</a>);</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="comment">// Unregisters a callback previously registered. It fails (with a CHECK) if</span></div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="comment">// the callback was already unregistered or unkonwn. After this calls returns,</span></div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="comment">// the caller can assume the callback won't be called.</span></div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// This function can't be called from a callback since this would result in a</span></div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// deadlock.</span></div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a4c8dcbfabcfc6917193242f5e010c974">RemoveInterruptionCallback</a>(CallbackId <span class="keywordtype">id</span>);</div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// This atomic must never be reset to true!</span></div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// The mutex_ should be held when setting it to true.</span></div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> std::atomic<bool> interrupted_ = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> absl::Mutex mutex_;</div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="comment">// The id to use for the next registered callback.</span></div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> CallbackId next_callback_id_ ABSL_GUARDED_BY(mutex_) = {};</div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="comment">// The list of callbacks. We use a linked_hash_map to make sure the order of</span></div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="comment">// calls to callback when the interrupter is triggered is stable.</span></div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <a class="code hl_class" href="classgtl_1_1linked__hash__map.html">gtl::linked_hash_map<CallbackId, Callback></a> callbacks_ ABSL_GUARDED_BY(mutex_);</div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span>};</div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment">// Class implementing RAII for interruption callbacks.</span></div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="comment">// Usage:</span></div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="comment">// SolveInterrupter* const interrupter = ...;</span></div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment">// {</span></div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="comment">// const ScopedSolveInterrupterCallback scoped_intr_cb(interrupter, [](){</span></div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment">// // Do something when/if interrupter is not nullptr and is triggered.</span></div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="comment">// }</span></div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="comment">// ...</span></div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="comment">// }</span></div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="comment">// // At this point, the callback will have been removed.</span></div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="comment">// The function RemoveCallbackIfNecessary() can be used to remove the callback</span></div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="comment">// before the destruction of this object.</span></div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_scoped_solve_interrupter_callback.html"> 117</a></span><span class="keyword">class </span><a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_scoped_solve_interrupter_callback.html">ScopedSolveInterrupterCallback</a> {</div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="comment">// Adds a callback to the interrupter if it is not nullptr. Does nothing when</span></div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="comment">// interrupter is nullptr.</span></div>
|
|
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_scoped_solve_interrupter_callback.html#a4117bac53668069c2defd36caf4dea55">ScopedSolveInterrupterCallback</a>(<a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html">SolveInterrupter</a>* interrupter,</div>
|
|
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <a class="code hl_typedef" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a9f4d3f1692b57758c10763bea8a50a04">SolveInterrupter::Callback</a> <a class="code hl_variable" href="gurobi__interface_8cc.html#a6627a3800ac768bb5528ef54c9cace36">callback</a>);</div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> </div>
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <span class="comment">// Removes the callback if necessary.</span></div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_scoped_solve_interrupter_callback.html#a62c624498e1781c402d4680ca9067f36">~ScopedSolveInterrupterCallback</a>();</div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
|
|
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <span class="comment">// Removes the callback from the interrupter. If it has already been removed</span></div>
|
|
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <span class="comment">// by a previous call or if a null interrupter was passed to the constructor,</span></div>
|
|
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="comment">// this function has no effect.</span></div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_scoped_solve_interrupter_callback.html#aa162749da4db402cabeebf639d3edde9">RemoveCallbackIfNecessary</a>();</div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> </div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> <span class="comment">// Optional interrupter.</span></div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html">SolveInterrupter</a>* <span class="keyword">const</span> interrupter_;</div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <span class="comment">// Unset after the callback has been reset.</span></div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> std::optional<SolveInterrupter::CallbackId> callback_id_;</div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span>};</div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> </div>
|
|
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span>} <span class="comment">// namespace math_opt</span></div>
|
|
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span>} <span class="comment">// namespace operations_research</span></div>
|
|
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> </div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span><span class="preprocessor">#endif </span><span class="comment">// OR_TOOLS_MATH_OPT_CORE_SOLVE_INTERRUPTER_H_</span></div>
|
|
<div class="ttc" id="aclassgtl_1_1linked__hash__map_html"><div class="ttname"><a href="classgtl_1_1linked__hash__map.html">gtl::linked_hash_map</a></div><div class="ttdef"><b>Definition:</b> <a href="linked__hash__map_8h_source.html#l00052">linked_hash_map.h:52</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_scoped_solve_interrupter_callback_html"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_scoped_solve_interrupter_callback.html">operations_research::math_opt::ScopedSolveInterrupterCallback</a></div><div class="ttdef"><b>Definition:</b> <a href="solve__interrupter_8h_source.html#l00117">solve_interrupter.h:117</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_scoped_solve_interrupter_callback_html_a4117bac53668069c2defd36caf4dea55"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_scoped_solve_interrupter_callback.html#a4117bac53668069c2defd36caf4dea55">operations_research::math_opt::ScopedSolveInterrupterCallback::ScopedSolveInterrupterCallback</a></div><div class="ttdeci">ScopedSolveInterrupterCallback(SolveInterrupter *interrupter, SolveInterrupter::Callback callback)</div><div class="ttdef"><b>Definition:</b> <a href="solve__interrupter_8cc_source.html#l00082">solve_interrupter.cc:82</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_scoped_solve_interrupter_callback_html_a62c624498e1781c402d4680ca9067f36"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_scoped_solve_interrupter_callback.html#a62c624498e1781c402d4680ca9067f36">operations_research::math_opt::ScopedSolveInterrupterCallback::~ScopedSolveInterrupterCallback</a></div><div class="ttdeci">~ScopedSolveInterrupterCallback()</div><div class="ttdef"><b>Definition:</b> <a href="solve__interrupter_8cc_source.html#l00091">solve_interrupter.cc:91</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_scoped_solve_interrupter_callback_html_aa162749da4db402cabeebf639d3edde9"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_scoped_solve_interrupter_callback.html#aa162749da4db402cabeebf639d3edde9">operations_research::math_opt::ScopedSolveInterrupterCallback::RemoveCallbackIfNecessary</a></div><div class="ttdeci">void RemoveCallbackIfNecessary()</div><div class="ttdef"><b>Definition:</b> <a href="solve__interrupter_8cc_source.html#l00095">solve_interrupter.cc:95</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solve_interrupter_html"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html">operations_research::math_opt::SolveInterrupter</a></div><div class="ttdef"><b>Definition:</b> <a href="solve__interrupter_8h_source.html#l00039">solve_interrupter.h:39</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solve_interrupter_html_a196eaec60854e829cac61e645c79b496"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a196eaec60854e829cac61e645c79b496">operations_research::math_opt::SolveInterrupter::operator=</a></div><div class="ttdeci">SolveInterrupter & operator=(const SolveInterrupter &)=delete</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solve_interrupter_html_a31cbaf141396f29d05b73b5350b29ed1"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a31cbaf141396f29d05b73b5350b29ed1">operations_research::math_opt::SolveInterrupter::IsInterrupted</a></div><div class="ttdeci">bool IsInterrupted() const</div><div class="ttdef"><b>Definition:</b> <a href="solve__interrupter_8h_source.html#l00063">solve_interrupter.h:63</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solve_interrupter_html_a4c8dcbfabcfc6917193242f5e010c974"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a4c8dcbfabcfc6917193242f5e010c974">operations_research::math_opt::SolveInterrupter::RemoveInterruptionCallback</a></div><div class="ttdeci">void RemoveInterruptionCallback(CallbackId id)</div><div class="ttdef"><b>Definition:</b> <a href="solve__interrupter_8cc_source.html#l00077">solve_interrupter.cc:77</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solve_interrupter_html_a6e2dbc96b2f157fb0bba2cef9e7607d7"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a6e2dbc96b2f157fb0bba2cef9e7607d7">operations_research::math_opt::SolveInterrupter::SolveInterrupter</a></div><div class="ttdeci">SolveInterrupter(const SolveInterrupter &)=delete</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solve_interrupter_html_a911dee5bfdb399422eb33d0486ed0934"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a911dee5bfdb399422eb33d0486ed0934">operations_research::math_opt::SolveInterrupter::AddInterruptionCallback</a></div><div class="ttdeci">CallbackId AddInterruptionCallback(Callback callback)</div><div class="ttdef"><b>Definition:</b> <a href="solve__interrupter_8cc_source.html#l00055">solve_interrupter.cc:55</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solve_interrupter_html_a99023201ed82f56c6ccd6646b6ae583d"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a99023201ed82f56c6ccd6646b6ae583d">operations_research::math_opt::SolveInterrupter::SolveInterrupter</a></div><div class="ttdeci">SolveInterrupter()=default</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solve_interrupter_html_a9f4d3f1692b57758c10763bea8a50a04"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#a9f4d3f1692b57758c10763bea8a50a04">operations_research::math_opt::SolveInterrupter::Callback</a></div><div class="ttdeci">std::function< void()> Callback</div><div class="ttdef"><b>Definition:</b> <a href="solve__interrupter_8h_source.html#l00044">solve_interrupter.h:44</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solve_interrupter_html_ac1c30a63fcff78de5e4924f7ee2b822e"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#ac1c30a63fcff78de5e4924f7ee2b822e">operations_research::math_opt::SolveInterrupter::Interrupt</a></div><div class="ttdeci">void Interrupt()</div><div class="ttdef"><b>Definition:</b> <a href="solve__interrupter_8cc_source.html#l00030">solve_interrupter.cc:30</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solve_interrupter_html_ad9f6f05a4b4ba43054d9e545cf1b3930"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solve_interrupter.html#ad9f6f05a4b4ba43054d9e545cf1b3930">operations_research::math_opt::SolveInterrupter::DEFINE_STRONG_INT_TYPE</a></div><div class="ttdeci">DEFINE_STRONG_INT_TYPE(CallbackId, int64_t)</div></div>
|
|
<div class="ttc" id="agurobi__interface_8cc_html_a6627a3800ac768bb5528ef54c9cace36"><div class="ttname"><a href="gurobi__interface_8cc.html#a6627a3800ac768bb5528ef54c9cace36">callback</a></div><div class="ttdeci">MPCallback * callback</div><div class="ttdef"><b>Definition:</b> <a href="gurobi__interface_8cc_source.html#l00515">gurobi_interface.cc:515</a></div></div>
|
|
<div class="ttc" id="alinked__hash__map_8h_html"><div class="ttname"><a href="linked__hash__map_8h.html">linked_hash_map.h</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1math__opt_html"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html">operations_research::math_opt</a></div><div class="ttdef"><b>Definition:</b> <a href="arrow__operator__proxy_8h_source.html#l00020">arrow_operator_proxy.h:20</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1math__opt_html_a9d73bc1014f12f33dfaa51825ad668ee"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a9d73bc1014f12f33dfaa51825ad668ee">operations_research::math_opt::Callback</a></div><div class="ttdeci">std::function< CallbackResult(const CallbackData &)> Callback</div><div class="ttdef"><b>Definition:</b> <a href="callback_8h_source.html#l00089">callback.h:89</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdoc">Collection of objects used to extend the Constraint Solver library.</div><div class="ttdef"><b>Definition:</b> <a href="dense__doubly__linked__list_8h_source.html#l00021">dense_doubly_linked_list.h:21</a></div></div>
|
|
<div class="ttc" id="astrong__int_8h_html"><div class="ttname"><a href="strong__int_8h.html">strong_int.h</a></div></div>
|
|
</div><!-- fragment --></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>
|
|
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_1defc00030ff81d309105e053121082f.html">math_opt</a></li><li class="navelem"><a class="el" href="dir_d5b95ec3710e8b09bb3a6564ed5074d8.html">core</a></li><li class="navelem"><a class="el" href="solve__interrupter_8h.html">solve_interrupter.h</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.3 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|