320 lines
44 KiB
HTML
320 lines
44 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.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: gscip_solver_callback.cc 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.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('gscip__solver__callback_8cc_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">gscip_solver_callback.cc</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="gscip__solver__callback_8cc.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright 2010-2021 Google LLC</span></div>
|
|
<div class="line"><a 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 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 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 name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div>
|
|
<div class="line"><a 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 name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div>
|
|
<div class="line"><a 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 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 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 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 name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// limitations under the License.</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "<a class="code" href="gscip__solver__callback_8h.html">ortools/math_opt/solvers/gscip_solver_callback.h</a>"</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <functional></span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <utility></span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="base_2logging_8h.html">ortools/base/logging.h</a>"</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "absl/container/flat_hash_set.h"</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "absl/memory/memory.h"</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "absl/status/status.h"</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "absl/status/statusor.h"</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "absl/strings/string_view.h"</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "absl/synchronization/mutex.h"</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "absl/time/clock.h"</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "absl/time/time.h"</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "absl/types/optional.h"</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "scip/scip.h"</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "scip/type_scip.h"</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="gscip__message__handler_8h.html">ortools/gscip/gscip_message_handler.h</a>"</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "<a class="code" href="scip__helper__macros_8h.html">ortools/linear_solver/scip_helper_macros.h</a>"</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "ortools/math_opt/callback.pb.h"</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "<a class="code" href="math__opt__proto__utils_8h.html">ortools/math_opt/math_opt_proto_utils.h</a>"</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "<a class="code" href="solver__interface_8h.html">ortools/math_opt/solver_interface.h</a>"</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include "<a class="code" href="message__callback__data_8h.html">ortools/math_opt/solvers/message_callback_data.h</a>"</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include "<a class="code" href="status__macros_8h.html">ortools/base/status_macros.h</a>"</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include "<a class="code" href="protoutil_8h.html">ortools/base/protoutil.h</a>"</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">namespace </span><a class="code" href="namespaceoperations__research.html">operations_research</a> {</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">namespace </span>math_opt {</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> std::unique_ptr<GScipSolverCallbackHandler></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler.html#a22cd7715028df18c5f7fc75837b3975b"> 45</a></span> <a class="code" href="classoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler.html#a22cd7715028df18c5f7fc75837b3975b">GScipSolverCallbackHandler::RegisterIfNeeded</a>(</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">const</span> CallbackRegistrationProto& callback_registration,</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">const</span> <a class="code" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ab47a61ca53ae9cdf35dd4f2dfc9ecadb">SolverInterface::Callback</a> <a class="code" href="gurobi__interface_8cc.html#a6627a3800ac768bb5528ef54c9cace36">callback</a>, <span class="keyword">const</span> absl::Time solve_start,</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  SCIP* <span class="keyword">const</span> scip) {</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// TODO(b/180617976): Don't ignore unknown callbacks.</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">const</span> absl::flat_hash_set<CallbackEventProto> events =</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="namespaceoperations__research_1_1math__opt.html#af457f60ebac293554106c3ee3898607e">EventSet</a>(callback_registration);</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">if</span> (!events.contains(CALLBACK_EVENT_MESSAGE)) {</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  }</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">return</span> absl::WrapUnique(</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">new</span> <a class="code" href="classoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler.html#af73659e6ed12390aa474bb5819a93f92">GScipSolverCallbackHandler</a>(<a class="code" href="gurobi__interface_8cc.html#a6627a3800ac768bb5528ef54c9cace36">callback</a>, solve_start, scip));</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> }</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <a class="code" href="classoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler.html#af73659e6ed12390aa474bb5819a93f92">GScipSolverCallbackHandler::GScipSolverCallbackHandler</a>(</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ab47a61ca53ae9cdf35dd4f2dfc9ecadb">SolverInterface::Callback</a> <a class="code" href="gurobi__interface_8cc.html#a6627a3800ac768bb5528ef54c9cace36">callback</a>, absl::Time solve_start,</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  SCIP* <span class="keyword">const</span> scip)</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  : callback_(std::move(<a class="code" href="base_2logging_8h.html#aeef651f886eb5252c08835194213efe2">ABSL_DIE_IF_NULL</a>(<a class="code" href="gurobi__interface_8cc.html#a6627a3800ac768bb5528ef54c9cace36">callback</a>))),</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  solve_start_(std::move(solve_start)),</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  scip_(<a class="code" href="base_2logging_8h.html#aeef651f886eb5252c08835194213efe2">ABSL_DIE_IF_NULL</a>(scip)) {}</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler.html#a4b70aa63f251813bb58fbb07b511ecea"> 67</a></span> <a class="code" href="namespaceoperations__research.html#a2899c1afc60224e18c3d9d4a95c5064e">GScipMessageHandler</a> <a class="code" href="classoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler.html#a4b70aa63f251813bb58fbb07b511ecea">GScipSolverCallbackHandler::MessageHandler</a>() {</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">return</span> std::bind(&GScipSolverCallbackHandler::MessageCallback, <span class="keyword">this</span>,</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  std::placeholders::_1, std::placeholders::_2);</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> }</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler.html#a58544266058bce093b84364979af75ba"> 72</a></span> absl::Status <a class="code" href="classoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler.html#a58544266058bce093b84364979af75ba">GScipSolverCallbackHandler::Flush</a>() {</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  {</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// Here we don't expect to be called in MessageCallback() at the same time</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// since GScip is not supposed to call the callback given to GScip::Solve()</span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// after the end of this Solve(). But we lock anyway in case GScip does not</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// honor its contract or if the caller calls Flush() before the end of the</span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// GScip::Solve().</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// See MessageCallback() for the rationale of keeping the lock while calling</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">// CallUserCallback().</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">const</span> absl::MutexLock lock(&message_mutex_);</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  absl::optional<CallbackDataProto> data = message_callback_data_.Flush();</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">if</span> (data) {</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a>(<a class="code" href="namespaceutil__time.html#ac1935e49a14ae747b6ee76804b52bf70">util_time::EncodeGoogleApiProto</a>(</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  absl::Now() - solve_start_, data->mutable_runtime()))</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  << <span class="stringliteral">"Failed to encode the time."</span>;</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  CallUserCallback(*data);</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  }</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">const</span> absl::MutexLock lock(&callback_mutex_);</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">return</span> status_;</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> }</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keywordtype">void</span> GScipSolverCallbackHandler::MessageCallback(</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">const</span> <a class="code" href="namespaceoperations__research.html#ab05776694f43218498fa4ccdbd8cf982">GScipMessageType</a> type, <span class="keyword">const</span> absl::string_view <a class="code" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>) {</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="comment">// We hold the mutex until the end of the call of the user callback to ensure</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">// proper ordering of messages. We don't expect any user action in the user</span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="comment">// callback to trigger another call to MessageCallback(). If it happens to be</span></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="comment">// the case then we will need to make the code of CallUserCallback()</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">// asynchronous to ensure that we don't end up making recursive calls to the</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="comment">// user callback.</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">const</span> absl::MutexLock lock(&message_mutex_);</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  </div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  absl::optional<CallbackDataProto> data =</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  message_callback_data_.Parse(<a class="code" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>);</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordflow">if</span> (!data) {</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  }</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">const</span> absl::Status runtime_status = <a class="code" href="namespaceutil__time.html#ac1935e49a14ae747b6ee76804b52bf70">util_time::EncodeGoogleApiProto</a>(</div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  absl::Now() - solve_start_, data->mutable_runtime());</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordflow">if</span> (!runtime_status.ok()) {</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  absl::MutexLock lock(&callback_mutex_);</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="comment">// Here we must not modify the status if it is already not OK.</span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordflow">if</span> (!status_.ok()) {</div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  }</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  status_ = <a class="code" href="classutil_1_1_status_builder.html">util::StatusBuilder</a>(runtime_status)</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  << <span class="stringliteral">"Failed to encode the time."</span>;</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="comment">// TODO(b/182919884): Make sure it is correct to use SCIPinterruptSolve()</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="comment">// here and maybe migrate to the same architecture as the one used to</span></div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="comment">// interrupt the solve from foreign threads..</span></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">const</span> <span class="keyword">auto</span> interrupt_status = <a class="code" href="scip__helper__macros_8h.html#a01a5597b6c8cb50ac465e5abebf00eec">SCIP_TO_STATUS</a>(SCIPinterruptSolve(scip_));</div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <a class="code" href="base_2logging_8h.html#a09f7d88282cf92c9f231270ac113e5c6">LOG_IF</a>(<a class="code" href="log__severity_8h.html#ac9bcbe19995a8140cd4ec61773cd6e67">ERROR</a>, !interrupt_status.ok())</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  << <span class="stringliteral">"Failed to interrupt the solve on error: "</span> << interrupt_status;</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  }</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  </div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="comment">// Events of type CALLBACK_EVENT_MESSAGE are not expected to return anything</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="comment">// but `terminate`. Since CallUserCallback() already handles the termination,</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="comment">// we can simply ignore the returned value here.</span></div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  CallUserCallback(*data);</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> }</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  </div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> absl::optional<CallbackResultProto></div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> GScipSolverCallbackHandler::CallUserCallback(</div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">const</span> CallbackDataProto& callback_data) {</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="comment">// We hold the lock during the call of the user callback to ensure only one</span></div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="comment">// call execute at a time. Having multiple calls at once may be an issue when</span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="comment">// the user asks for termination since it may ask for it in one call while</span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="comment">// another thread is about to make its call for another callback.</span></div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="comment">// We don't expect any valid actions taken by the user is a callback to lead</span></div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="comment">// to another callback. That said, a potential corner case could be that</span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="comment">// adding a constraint lead to a message callback. If this happens, then this</span></div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="comment">// code will need to be made more complex to deal with that. And there won't</span></div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="comment">// be any easy solution.</span></div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="comment">// The simplest would be to have the message callbacks being delivered by a</span></div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="comment">// background thread so that a call to MessageCallback() is never blocking on</span></div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="comment">// the user answering to it. The issue here would be to deal with `terminate`</span></div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="comment">// since we can't call SCIPinterruptSolve() from another thread than a SCIP</span></div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="comment">// thread (it is not thread safe). Maybe this means that `terminate` should</span></div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="comment">// not be callable for message callbacks, or that the termination should be</span></div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="comment">// delayed to the next time it can be made.</span></div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  absl::MutexLock lock(&callback_mutex_);</div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordflow">if</span> (!status_.ok()) {</div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordflow">return</span> absl::nullopt;</div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  }</div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  </div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  absl::StatusOr<CallbackResultProto> result_or = callback_(callback_data);</div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  status_ = result_or.status();</div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordflow">if</span> (!result_or.ok() || result_or->terminate()) {</div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="comment">// TODO(b/182919884): Make sure it is correct to use SCIPinterruptSolve()</span></div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="comment">// here and maybe migrate to the same architecture as the one used to</span></div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="comment">// interrupt the solve from foreign threads..</span></div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keyword">const</span> <span class="keyword">auto</span> interrupt_status = <a class="code" href="scip__helper__macros_8h.html#a01a5597b6c8cb50ac465e5abebf00eec">SCIP_TO_STATUS</a>(SCIPinterruptSolve(scip_));</div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keywordflow">if</span> (!interrupt_status.ok()) {</div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keywordflow">if</span> (status_.ok()) {</div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  status_ = interrupt_status;</div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  } <span class="keywordflow">else</span> {</div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <a class="code" href="base_2logging_8h.html#accad43a85d781d53381cd53a9894b6ae">LOG</a>(<a class="code" href="log__severity_8h.html#ac9bcbe19995a8140cd4ec61773cd6e67">ERROR</a>) << <span class="stringliteral">"Failed to interrupt the solve on error: "</span></div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  << interrupt_status;</div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  }</div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  }</div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordflow">return</span> absl::nullopt;</div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  }</div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  </div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordflow">return</span> *std::move(result_or);</div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> }</div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  </div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> } <span class="comment">// namespace math_opt</span></div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> } <span class="comment">// namespace operations_research</span></div>
|
|
<div class="ttc" id="abase_2logging_8h_html"><div class="ttname"><a href="base_2logging_8h.html">logging.h</a></div></div>
|
|
<div class="ttc" id="abase_2logging_8h_html_a09f7d88282cf92c9f231270ac113e5c6"><div class="ttname"><a href="base_2logging_8h.html#a09f7d88282cf92c9f231270ac113e5c6">LOG_IF</a></div><div class="ttdeci">#define LOG_IF(severity, condition)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00482">base/logging.h:482</a></div></div>
|
|
<div class="ttc" id="abase_2logging_8h_html_accad43a85d781d53381cd53a9894b6ae"><div class="ttname"><a href="base_2logging_8h.html#accad43a85d781d53381cd53a9894b6ae">LOG</a></div><div class="ttdeci">#define LOG(severity)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00423">base/logging.h:423</a></div></div>
|
|
<div class="ttc" id="abase_2logging_8h_html_aeef651f886eb5252c08835194213efe2"><div class="ttname"><a href="base_2logging_8h.html#aeef651f886eb5252c08835194213efe2">ABSL_DIE_IF_NULL</a></div><div class="ttdeci">#define ABSL_DIE_IF_NULL</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00041">base/logging.h:41</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler_html_a22cd7715028df18c5f7fc75837b3975b"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler.html#a22cd7715028df18c5f7fc75837b3975b">operations_research::math_opt::GScipSolverCallbackHandler::RegisterIfNeeded</a></div><div class="ttdeci">static std::unique_ptr< GScipSolverCallbackHandler > RegisterIfNeeded(const CallbackRegistrationProto &callback_registration, SolverInterface::Callback callback, absl::Time solve_start, SCIP *scip)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__solver__callback_8cc_source.html#l00045">gscip_solver_callback.cc:45</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler_html_a4b70aa63f251813bb58fbb07b511ecea"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler.html#a4b70aa63f251813bb58fbb07b511ecea">operations_research::math_opt::GScipSolverCallbackHandler::MessageHandler</a></div><div class="ttdeci">GScipMessageHandler MessageHandler()</div><div class="ttdef"><b>Definition:</b> <a href="gscip__solver__callback_8cc_source.html#l00067">gscip_solver_callback.cc:67</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler_html_a58544266058bce093b84364979af75ba"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler.html#a58544266058bce093b84364979af75ba">operations_research::math_opt::GScipSolverCallbackHandler::Flush</a></div><div class="ttdeci">absl::Status Flush()</div><div class="ttdef"><b>Definition:</b> <a href="gscip__solver__callback_8cc_source.html#l00072">gscip_solver_callback.cc:72</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler_html_af73659e6ed12390aa474bb5819a93f92"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_g_scip_solver_callback_handler.html#af73659e6ed12390aa474bb5819a93f92">operations_research::math_opt::GScipSolverCallbackHandler::GScipSolverCallbackHandler</a></div><div class="ttdeci">GScipSolverCallbackHandler(const GScipSolverCallbackHandler &)=delete</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solver_interface_html_ab47a61ca53ae9cdf35dd4f2dfc9ecadb"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ab47a61ca53ae9cdf35dd4f2dfc9ecadb">operations_research::math_opt::SolverInterface::Callback</a></div><div class="ttdeci">std::function< absl::StatusOr< CallbackResultProto >(const CallbackDataProto &)> Callback</div><div class="ttdef"><b>Definition:</b> <a href="solver__interface_8h_source.html#l00054">solver_interface.h:55</a></div></div>
|
|
<div class="ttc" id="aclassutil_1_1_status_builder_html"><div class="ttname"><a href="classutil_1_1_status_builder.html">util::StatusBuilder</a></div><div class="ttdef"><b>Definition:</b> <a href="status__builder_8h_source.html#l00023">status_builder.h:23</a></div></div>
|
|
<div class="ttc" id="agscip__message__handler_8h_html"><div class="ttname"><a href="gscip__message__handler_8h.html">gscip_message_handler.h</a></div></div>
|
|
<div class="ttc" id="agscip__solver__callback_8h_html"><div class="ttname"><a href="gscip__solver__callback_8h.html">gscip_solver_callback.h</a></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#l00514">gurobi_interface.cc:514</a></div></div>
|
|
<div class="ttc" id="alog__severity_8h_html_ac9bcbe19995a8140cd4ec61773cd6e67"><div class="ttname"><a href="log__severity_8h.html#ac9bcbe19995a8140cd4ec61773cd6e67">ERROR</a></div><div class="ttdeci">const int ERROR</div><div class="ttdef"><b>Definition:</b> <a href="log__severity_8h_source.html#l00032">log_severity.h:32</a></div></div>
|
|
<div class="ttc" id="amath__opt__proto__utils_8h_html"><div class="ttname"><a href="math__opt__proto__utils_8h.html">math_opt_proto_utils.h</a></div></div>
|
|
<div class="ttc" id="amessage__callback__data_8h_html"><div class="ttname"><a href="message__callback__data_8h.html">message_callback_data.h</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1math__opt_html_af457f60ebac293554106c3ee3898607e"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#af457f60ebac293554106c3ee3898607e">operations_research::math_opt::EventSet</a></div><div class="ttdeci">absl::flat_hash_set< CallbackEventProto > EventSet(const CallbackRegistrationProto &callback_registration)</div><div class="ttdef"><b>Definition:</b> <a href="math__opt__proto__utils_8cc_source.html#l00067">math_opt_proto_utils.cc:67</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="anamespaceoperations__research_html_a2899c1afc60224e18c3d9d4a95c5064e"><div class="ttname"><a href="namespaceoperations__research.html#a2899c1afc60224e18c3d9d4a95c5064e">operations_research::GScipMessageHandler</a></div><div class="ttdeci">std::function< void(GScipMessageType type, absl::string_view message)> GScipMessageHandler</div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8h_source.html#l00036">gscip_message_handler.h:37</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_ab05776694f43218498fa4ccdbd8cf982"><div class="ttname"><a href="namespaceoperations__research.html#ab05776694f43218498fa4ccdbd8cf982">operations_research::GScipMessageType</a></div><div class="ttdeci">GScipMessageType</div><div class="ttdef"><b>Definition:</b> <a href="gscip__message__handler_8h_source.html#l00028">gscip_message_handler.h:28</a></div></div>
|
|
<div class="ttc" id="anamespaceutil__time_html_ac1935e49a14ae747b6ee76804b52bf70"><div class="ttname"><a href="namespaceutil__time.html#ac1935e49a14ae747b6ee76804b52bf70">util_time::EncodeGoogleApiProto</a></div><div class="ttdeci">inline ::absl::StatusOr< google::protobuf::Duration > EncodeGoogleApiProto(absl::Duration d)</div><div class="ttdef"><b>Definition:</b> <a href="protoutil_8h_source.html#l00027">protoutil.h:27</a></div></div>
|
|
<div class="ttc" id="aprotoutil_8h_html"><div class="ttname"><a href="protoutil_8h.html">protoutil.h</a></div></div>
|
|
<div class="ttc" id="ascip__helper__macros_8h_html"><div class="ttname"><a href="scip__helper__macros_8h.html">scip_helper_macros.h</a></div></div>
|
|
<div class="ttc" id="ascip__helper__macros_8h_html_a01a5597b6c8cb50ac465e5abebf00eec"><div class="ttname"><a href="scip__helper__macros_8h.html#a01a5597b6c8cb50ac465e5abebf00eec">SCIP_TO_STATUS</a></div><div class="ttdeci">#define SCIP_TO_STATUS(x)</div><div class="ttdef"><b>Definition:</b> <a href="scip__helper__macros_8h_source.html#l00039">scip_helper_macros.h:39</a></div></div>
|
|
<div class="ttc" id="asolver__interface_8h_html"><div class="ttname"><a href="solver__interface_8h.html">solver_interface.h</a></div></div>
|
|
<div class="ttc" id="astatus__macros_8h_html"><div class="ttname"><a href="status__macros_8h.html">status_macros.h</a></div></div>
|
|
<div class="ttc" id="astatus__macros_8h_html_acdc223d8c59d5c591dc6b4e88257627b"><div class="ttname"><a href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a></div><div class="ttdeci">#define RETURN_IF_ERROR(expr)</div><div class="ttdef"><b>Definition:</b> <a href="status__macros_8h_source.html#l00029">status_macros.h:29</a></div></div>
|
|
<div class="ttc" id="atrace_8cc_html_a36bd74109f547f7f8198faf5a12d2879"><div class="ttname"><a href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a></div><div class="ttdeci">std::string message</div><div class="ttdef"><b>Definition:</b> <a href="trace_8cc_source.html#l00398">trace.cc:398</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_6a51feaf2b7f0a1d5cfa932e9ba3d2cd.html">solvers</a></li><li class="navelem"><a class="el" href="gscip__solver__callback_8cc.html">gscip_solver_callback.cc</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.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|