always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
560826496b0f15793ce2ee3dfffb3bee2abfddec
ortools-clone/docs/cpp/gscip__event__handler_8h_source.html
Mizux Seiha 17edcf0e25 Update doc
2021-09-30 01:28:18 +02:00

319 lines
46 KiB
HTML
Raw Blame History

<!-- 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.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: gscip_event_handler.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
&#160;<span id="projectnumber">9.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('gscip__event__handler_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">gscip_event_handler.h</div></div>
</div><!--header-->
<div class="contents">
<a href="gscip__event__handler_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 &quot;License&quot;);</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 &quot;AS IS&quot; 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="comment">// Provides a safe C++ interface for SCIP event handlers, which are described at</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">// https://www.scipopt.org/doc-7.0.1/html/EVENT.php.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#ifndef OR_TOOLS_GSCIP_GSCIP_EVENT_HANDLER_H_</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#define OR_TOOLS_GSCIP_GSCIP_EVENT_HANDLER_H_</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include &quot;<a class="code" href="gscip_8h.html">ortools/gscip/gscip.h</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &quot;scip/type_event.h&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research.html">operations_research</a> {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="structoperations__research_1_1_g_scip_event_handler_description.html"> 27</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structoperations__research_1_1_g_scip_event_handler_description.html">GScipEventHandlerDescription</a> {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// For the first two members below, the SCIP constraint handler</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// property name is provided. See</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// https://www.scipopt.org/doc-7.0.1/html/EVENT.php#EVENTHDLR_PROPERTIES for</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// details.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// See CONSHDLR_NAME in SCIP documentation above.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="structoperations__research_1_1_g_scip_event_handler_description.html#a9b45b3e13bd9167aab02e17e08916231"> 34</a></span> std::string <a class="code hl_variable" href="structoperations__research_1_1_g_scip_event_handler_description.html#a9b45b3e13bd9167aab02e17e08916231">name</a>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// See CONSHDLR_DESC in SCIP documentation above.</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="structoperations__research_1_1_g_scip_event_handler_description.html#a2e1454f6988673f814408646edaeb320"> 37</a></span> std::string <a class="code hl_variable" href="structoperations__research_1_1_g_scip_event_handler_description.html#a2e1454f6988673f814408646edaeb320">description</a>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>};</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">// Passed by value. This is a lightweight interface to the callback context and</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment">// the underlying problem. It&#39;s preferred for callbacks to use the context</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment">// object to query information rather than using the raw SCIP pointer, because</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">// the context object can be set up to do this in a safe way.</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_g_scip_event_handler_context.html"> 44</a></span><span class="keyword">class </span><a class="code hl_class" href="classoperations__research_1_1_g_scip_event_handler_context.html">GScipEventHandlerContext</a> {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_g_scip_event_handler_context.html#a6a3d8f7d66730fc4792ffd23a1174b2f"> 46</a></span> <a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler_context.html#a6a3d8f7d66730fc4792ffd23a1174b2f">GScipEventHandlerContext</a>(<a class="code hl_class" href="classoperations__research_1_1_g_scip.html">GScip</a>* <a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler_context.html#a1d902c54e1442c7c63466e0504c4f705">gscip</a>, SCIP_EVENTTYPE <a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler_context.html#a46f6218bbc44aafe327797363fd20cc9">event_type</a>)</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> : gscip_(<a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler_context.html#a1d902c54e1442c7c63466e0504c4f705">gscip</a>), event_type_(<a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler_context.html#a46f6218bbc44aafe327797363fd20cc9">event_type</a>) {}</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_g_scip_event_handler_context.html#a1d902c54e1442c7c63466e0504c4f705"> 49</a></span> <a class="code hl_class" href="classoperations__research_1_1_g_scip.html">GScip</a>* <a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler_context.html#a1d902c54e1442c7c63466e0504c4f705">gscip</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> gscip_; }</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">// This is always an atomic event type, not a mask (i.e., one of the events</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// defined as a bitwise OR).</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_g_scip_event_handler_context.html#a46f6218bbc44aafe327797363fd20cc9"> 53</a></span> SCIP_EVENTTYPE <a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler_context.html#a46f6218bbc44aafe327797363fd20cc9">event_type</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> event_type_; }</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// TODO(user): Support additional properties that might need to be</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// queried within an event handler.</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <a class="code hl_class" href="classoperations__research_1_1_g_scip.html">GScip</a>* <span class="keyword">const</span> gscip_;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">const</span> SCIP_EVENTTYPE event_type_;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>};</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment">// Inherit from this to implement the callback and override Init() to call</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment">// CatchEvent() for the events you want to listen to.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment">//</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment">// Usage:</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment">//</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment">// class MyHandler : public GScipEventHandler {</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment">// public:</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment">// MyHandler()</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="comment">// : GScipEventHandler({</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment">// .name = &quot;my handler&quot;, .description = &quot;something&quot;}) {}</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment">//</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment">// SCIP_RETCODE Init(GScip* const gscip) override {</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment">// SCIP_CALL(CatchEvent(SCIP_EVENTTYPE_SOLFOUND));</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment">// return SCIP_OKAY;</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment">// }</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment">//</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment">// SCIP_RETCODE Execute(const GScipEventHandlerContext context) override {</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment">// ...</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment">// return SCIP_OKAY;</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment">// }</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment">// };</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment">//</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment">// std::unique_ptr&lt;GScip&gt; gscip = ...;</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment">//</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment">// MyHandler handler;</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment">// handler.Register(gscip.get());</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment">//</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_g_scip_event_handler.html"> 90</a></span><span class="keyword">class </span><a class="code hl_class" href="classoperations__research_1_1_g_scip_event_handler.html">GScipEventHandler</a> {</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_g_scip_event_handler.html#af7cfe5b075a9359babf7e50af5ab0ea7"> 92</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler.html#af7cfe5b075a9359babf7e50af5ab0ea7">GScipEventHandler</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structoperations__research_1_1_g_scip_event_handler_description.html">GScipEventHandlerDescription</a>&amp; description)</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> : description_(description) {}</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_g_scip_event_handler.html#a172181c14c0a0d5171384a0377fc2341"> 95</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler.html#a172181c14c0a0d5171384a0377fc2341">~GScipEventHandler</a>() = <span class="keywordflow">default</span>;</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">// Registers this event handler to the given GScip.</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="comment">//</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="comment">// This function CHECKs that this handler has not been previously registered.</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="comment">//</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="comment">// The given GScip won&#39;t own this handler but will keep a pointer to it that</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <span class="comment">// will be used during the solve.</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler.html#a5c86c9f016d7d1dce57d83a04dc234ba">Register</a>(<a class="code hl_class" href="classoperations__research_1_1_g_scip.html">GScip</a>* gscip);</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="comment">// Initialization of the event handler. Called after the problem was</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="comment">// transformed.</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">// The implementation should use the CatchEvent() method to register to global</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="comment">// events.</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">// Return SCIP_OKAY, or use SCIP_CALL macro to wraps SCIP calls to properly</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="comment">// propagate errors.</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_g_scip_event_handler.html#a1d5da6cf76ace8b0ada0cb36477c47cf"> 113</a></span> <span class="keyword">virtual</span> SCIP_RETCODE <a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler.html#a1d5da6cf76ace8b0ada0cb36477c47cf">Init</a>(<a class="code hl_class" href="classoperations__research_1_1_g_scip.html">GScip</a>* gscip) { <span class="keywordflow">return</span> SCIP_OKAY; }</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="comment">// Called when a caught event is emitted.</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="comment">//</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="comment">// Return SCIP_OKAY, or use SCIP_CALL macro to wraps SCIP calls to properly</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="comment">// propagate errors.</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_g_scip_event_handler.html#a3db37da33025584bd2f7f9e5eb327316"> 119</a></span> <span class="keyword">virtual</span> SCIP_RETCODE <a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler.html#a3db37da33025584bd2f7f9e5eb327316">Execute</a>(<a class="code hl_class" href="classoperations__research_1_1_g_scip_event_handler_context.html">GScipEventHandlerContext</a> <a class="code hl_variable" href="gurobi__interface_8cc.html#a5f287b83a753915ae862fed64f8640a6">context</a>) {</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keywordflow">return</span> SCIP_OKAY;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> }</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="comment">// Deinitialization of the event handler.</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <span class="comment">//</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <span class="comment">// Called before the transformed problem is freed and after all the events</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> <span class="comment">// specified in CatchEvent() have been dropped (thus there is no need to</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <span class="comment">// implement this function to drop these events since this would have already</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <span class="comment">// been done).</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="comment">//</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <span class="comment">// Return SCIP_OKAY, or use SCIP_CALL macro to wraps SCIP calls to properly</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> <span class="comment">// propagate errors.</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_g_scip_event_handler.html#a7b155d3468652f190ee543976e2727b0"> 132</a></span> <span class="keyword">virtual</span> SCIP_RETCODE <a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler.html#a7b155d3468652f190ee543976e2727b0">Exit</a>(<a class="code hl_class" href="classoperations__research_1_1_g_scip.html">GScip</a>* gscip) { <span class="keywordflow">return</span> SCIP_OKAY; }</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> </div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> <span class="comment">// Catches a global event (i.e. not a variable or row depedent one) based on</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <span class="comment">// the input event_type mask.</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="comment">//</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="comment">// This method must only be called after the problem is transformed; typically</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="comment">// it is called in the Init() virtual method.</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <span class="comment">//</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> <span class="comment">// Caught events will be automatically dropped when the handler will be called</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> <span class="comment">// on EXIT (before calling the corresponding Exit() member function).</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> <span class="comment">//</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> <span class="comment">// See scip/type_event.h for the list of possible events. This function</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> <span class="comment">// corresponds to SCIPcatchEvent().</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> <span class="comment">//</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <span class="comment">// TODO(user): Support Var and Row events.</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> <span class="comment">//</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> <span class="comment">// TODO(user): Support registering events in the EVENTINITSOL</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> <span class="comment">// callback, which would cause them to be trapped only after presolve.</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> SCIP_RETCODE <a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler.html#ae2d1bf271e573bcc7dfb116eba591ed6">CatchEvent</a>(SCIP_EVENTTYPE event_type);</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <span class="keyword">struct </span>CaughtEvent {</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> CaughtEvent(<span class="keyword">const</span> SCIP_EVENTTYPE event_type, <span class="keyword">const</span> <span class="keywordtype">int</span> filter_pos)</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> : event_type(event_type), filter_pos(filter_pos) {}</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> </div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> <span class="comment">// The event_type mask for this catch.</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> SCIP_EVENTTYPE event_type;</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> </div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> <span class="comment">// The key used by SCIP to identify this catch with SCIPdropEvent(). Using</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> <span class="comment">// this key prevents SCIP from having to do a look up to find the catch and</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> <span class="comment">// helps when there are duplicates.</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> <span class="comment">//</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> <span class="comment">// It is the index of the data associated to the catch in the array SCIP</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> <span class="comment">// uses as storage (this index is stable, even after other catch added</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> <span class="comment">// previously are removed, since SCIP maintains a free-list of removed items</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> <span class="comment">// instead of renumbering all elements).</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> <span class="keywordtype">int</span> filter_pos;</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> };</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> </div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> <span class="comment">// Calls SCIPdropEvent() for all events in caught_events_ and clear this</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> <span class="comment">// collection.</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> <span class="comment">//</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> <span class="comment">// This is not a member function since it needs to be visible to the SCIP Exit</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> <span class="comment">// callback function.</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> <span class="keyword">friend</span> SCIP_RETCODE <a class="code hl_friend" href="classoperations__research_1_1_g_scip_event_handler.html#a0753b97dda1b61f2f935316868e2ecc4">DropAllEvents</a>(<a class="code hl_function" href="classoperations__research_1_1_g_scip_event_handler.html#af7cfe5b075a9359babf7e50af5ab0ea7">GScipEventHandler</a>&amp; handler);</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> </div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> <span class="keyword">const</span> GScipEventHandlerDescription description_;</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> <span class="comment">// Pointer to GScip set by Register();</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> GScip* gscip_ = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> </div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> <span class="comment">// Pointer to the event handler registered on SCIP.</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> SCIP_EVENTHDLR* event_handler_ = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> </div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> <span class="comment">// Caught events via CatchEvent().</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> std::vector&lt;CaughtEvent&gt; caught_events_;</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span>};</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> </div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span>} <span class="comment">// namespace operations_research</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> </div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span><span class="preprocessor">#endif </span><span class="comment">// OR_TOOLS_GSCIP_GSCIP_EVENT_HANDLER_H_</span></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_event_handler_context_html"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler_context.html">operations_research::GScipEventHandlerContext</a></div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00044">gscip_event_handler.h:44</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_event_handler_context_html_a1d902c54e1442c7c63466e0504c4f705"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler_context.html#a1d902c54e1442c7c63466e0504c4f705">operations_research::GScipEventHandlerContext::gscip</a></div><div class="ttdeci">GScip * gscip() const</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00049">gscip_event_handler.h:49</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_event_handler_context_html_a46f6218bbc44aafe327797363fd20cc9"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler_context.html#a46f6218bbc44aafe327797363fd20cc9">operations_research::GScipEventHandlerContext::event_type</a></div><div class="ttdeci">SCIP_EVENTTYPE event_type() const</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00053">gscip_event_handler.h:53</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_event_handler_context_html_a6a3d8f7d66730fc4792ffd23a1174b2f"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler_context.html#a6a3d8f7d66730fc4792ffd23a1174b2f">operations_research::GScipEventHandlerContext::GScipEventHandlerContext</a></div><div class="ttdeci">GScipEventHandlerContext(GScip *gscip, SCIP_EVENTTYPE event_type)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00046">gscip_event_handler.h:46</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_event_handler_html"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html">operations_research::GScipEventHandler</a></div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00090">gscip_event_handler.h:90</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_event_handler_html_a0753b97dda1b61f2f935316868e2ecc4"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#a0753b97dda1b61f2f935316868e2ecc4">operations_research::GScipEventHandler::DropAllEvents</a></div><div class="ttdeci">friend SCIP_RETCODE DropAllEvents(GScipEventHandler &amp;handler)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8cc_source.html#l00128">gscip_event_handler.cc:128</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_event_handler_html_a172181c14c0a0d5171384a0377fc2341"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#a172181c14c0a0d5171384a0377fc2341">operations_research::GScipEventHandler::~GScipEventHandler</a></div><div class="ttdeci">virtual ~GScipEventHandler()=default</div></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_event_handler_html_a1d5da6cf76ace8b0ada0cb36477c47cf"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#a1d5da6cf76ace8b0ada0cb36477c47cf">operations_research::GScipEventHandler::Init</a></div><div class="ttdeci">virtual SCIP_RETCODE Init(GScip *gscip)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00113">gscip_event_handler.h:113</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_event_handler_html_a3db37da33025584bd2f7f9e5eb327316"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#a3db37da33025584bd2f7f9e5eb327316">operations_research::GScipEventHandler::Execute</a></div><div class="ttdeci">virtual SCIP_RETCODE Execute(GScipEventHandlerContext context)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00119">gscip_event_handler.h:119</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_event_handler_html_a5c86c9f016d7d1dce57d83a04dc234ba"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#a5c86c9f016d7d1dce57d83a04dc234ba">operations_research::GScipEventHandler::Register</a></div><div class="ttdeci">void Register(GScip *gscip)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8cc_source.html#l00092">gscip_event_handler.cc:92</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_event_handler_html_a7b155d3468652f190ee543976e2727b0"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#a7b155d3468652f190ee543976e2727b0">operations_research::GScipEventHandler::Exit</a></div><div class="ttdeci">virtual SCIP_RETCODE Exit(GScip *gscip)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00132">gscip_event_handler.h:132</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_event_handler_html_ae2d1bf271e573bcc7dfb116eba591ed6"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#ae2d1bf271e573bcc7dfb116eba591ed6">operations_research::GScipEventHandler::CatchEvent</a></div><div class="ttdeci">SCIP_RETCODE CatchEvent(SCIP_EVENTTYPE event_type)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8cc_source.html#l00116">gscip_event_handler.cc:116</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_event_handler_html_af7cfe5b075a9359babf7e50af5ab0ea7"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#af7cfe5b075a9359babf7e50af5ab0ea7">operations_research::GScipEventHandler::GScipEventHandler</a></div><div class="ttdeci">GScipEventHandler(const GScipEventHandlerDescription &amp;description)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00092">gscip_event_handler.h:92</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_g_scip_html"><div class="ttname"><a href="classoperations__research_1_1_g_scip.html">operations_research::GScip</a></div><div class="ttdef"><b>Definition:</b> <a href="gscip_8h_source.html#l00127">gscip.h:127</a></div></div>
<div class="ttc" id="agscip_8h_html"><div class="ttname"><a href="gscip_8h.html">gscip.h</a></div></div>
<div class="ttc" id="agurobi__interface_8cc_html_a5f287b83a753915ae862fed64f8640a6"><div class="ttname"><a href="gurobi__interface_8cc.html#a5f287b83a753915ae862fed64f8640a6">context</a></div><div class="ttdeci">GurobiMPCallbackContext * context</div><div class="ttdef"><b>Definition:</b> <a href="gurobi__interface_8cc_source.html#l00513">gurobi_interface.cc:513</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="astructoperations__research_1_1_g_scip_event_handler_description_html"><div class="ttname"><a href="structoperations__research_1_1_g_scip_event_handler_description.html">operations_research::GScipEventHandlerDescription</a></div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00027">gscip_event_handler.h:27</a></div></div>
<div class="ttc" id="astructoperations__research_1_1_g_scip_event_handler_description_html_a2e1454f6988673f814408646edaeb320"><div class="ttname"><a href="structoperations__research_1_1_g_scip_event_handler_description.html#a2e1454f6988673f814408646edaeb320">operations_research::GScipEventHandlerDescription::description</a></div><div class="ttdeci">std::string description</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00037">gscip_event_handler.h:37</a></div></div>
<div class="ttc" id="astructoperations__research_1_1_g_scip_event_handler_description_html_a9b45b3e13bd9167aab02e17e08916231"><div class="ttname"><a href="structoperations__research_1_1_g_scip_event_handler_description.html#a9b45b3e13bd9167aab02e17e08916231">operations_research::GScipEventHandlerDescription::name</a></div><div class="ttdeci">std::string name</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00034">gscip_event_handler.h:34</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_7ebe005d782fae78e581b12d74364053.html">gscip</a></li><li class="navelem"><a class="el" href="gscip__event__handler_8h.html">gscip_event_handler.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.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink