276 lines
42 KiB
HTML
276 lines
42 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.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: subsolver.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.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&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('subsolver_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">subsolver.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="subsolver_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="comment">// Simple framework for choosing and distributing a solver "sub-tasks" on a set</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">// of threads.</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">#ifndef OR_TOOLS_SAT_SUBSOLVER_H_</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#define OR_TOOLS_SAT_SUBSOLVER_H_</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include <algorithm></span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include <cmath></span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <cstdint></span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <functional></span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <vector></span></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"> 27</span><span class="preprocessor">#include "<a class="code" href="integral__types_8h.html">ortools/base/integral_types.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="preprocessor">#if !defined(__PORTABLE_PLATFORM__)</span></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "<a class="code" href="threadpool_8h.html">ortools/base/threadpool.h</a>"</span></div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#endif </span><span class="comment">// __PORTABLE_PLATFORM__</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="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research.html">operations_research</a> {</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">namespace </span>sat {</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">// The API used for distributing work. Each subsolver can generate tasks and</span></div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">// synchronize itself with the rest of the world.</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment">// Note that currently only the main thread interact with subsolvers. Only the</span></div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">// tasks generated by GenerateTask() are executed in parallel in a threadpool.</span></div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_sub_solver.html"> 41</a></span><span class="keyword">class </span><a class="code hl_class" href="classoperations__research_1_1sat_1_1_sub_solver.html">SubSolver</a> {</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_sub_solver.html#ad2e23c304e8cbcd373924635e0a2a9fa"> 43</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classoperations__research_1_1sat_1_1_sub_solver.html#ad2e23c304e8cbcd373924635e0a2a9fa">SubSolver</a>(<span class="keyword">const</span> std::string& <a class="code hl_function" href="classoperations__research_1_1sat_1_1_sub_solver.html#a1d89c28bd42ba9a52da008bb69367171">name</a>) : <a class="code hl_variable" href="classoperations__research_1_1sat_1_1_sub_solver.html#a723d30392e2c4f36252de0528a1b246d">name_</a>(<a class="code hl_function" href="classoperations__research_1_1sat_1_1_sub_solver.html#a1d89c28bd42ba9a52da008bb69367171">name</a>) {}</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_sub_solver.html#a5b73fdbea9375b397b31686866d7fdec"> 44</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classoperations__research_1_1sat_1_1_sub_solver.html#a5b73fdbea9375b397b31686866d7fdec">~SubSolver</a>() {}</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"> 46</span> <span class="comment">// Returns true iff GenerateTask() can be called.</span></div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// Note(user): In the current design, a SubSolver is never deleted until the</span></div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// end of the Solve() that created it. But is is okay to always return false</span></div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// here and release the memory used by the Subsolver internal if there is no</span></div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// need to call this Subsolver ever again. The overhead of iterating over it</span></div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// in the main solver loop should be minimal.</span></div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_sub_solver.html#a1754d73c22a8492998b642c9d8df907a"> 53</a></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classoperations__research_1_1sat_1_1_sub_solver.html#a1754d73c22a8492998b642c9d8df907a">TaskIsAvailable</a>() = 0;</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">// Returns a task to run. The task_id is just an ever increasing counter that</span></div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// correspond to the number of total calls to GenerateTask().</span></div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// TODO(user): We could use a more complex selection logic and pass in the</span></div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// deterministic time limit this subtask should run for. Unclear at this</span></div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// stage.</span></div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_sub_solver.html#aa0b5c5345729a33212c0deae55d14354"> 61</a></span> <span class="keyword">virtual</span> std::function<void()> <a class="code hl_function" href="classoperations__research_1_1sat_1_1_sub_solver.html#aa0b5c5345729a33212c0deae55d14354">GenerateTask</a>(int64_t task_id) = 0;</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">// Synchronizes with the external world from this SubSolver point of view.</span></div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="comment">// Also incorporate the results of the latest completed tasks if any.</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">// Note(user): The intended implementation for determinism is that tasks</span></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// update asynchronously (and so non-deterministically) global "shared"</span></div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// classes, but this global state is incorporated by the Subsolver only when</span></div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// Synchronize() is called.</span></div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_sub_solver.html#ae13c194d355f54c75f87897e3c5beb6b"> 70</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1sat_1_1_sub_solver.html#ae13c194d355f54c75f87897e3c5beb6b">Synchronize</a>() = 0;</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="comment">// Returns the score as updated by the completed tasks before the last</span></div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// Synchronize() call. Everything else being equal, we prefer to run a</span></div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// SubSolver with the highest score.</span></div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// TODO(user): This is unused for now.</span></div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_sub_solver.html#a321c6d764d7a95cb82eea2a0e1198028"> 77</a></span> <span class="keywordtype">double</span> <a class="code hl_function" href="classoperations__research_1_1sat_1_1_sub_solver.html#a321c6d764d7a95cb82eea2a0e1198028">score</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classoperations__research_1_1sat_1_1_sub_solver.html#ae8a019e95b21b6721e045ec56589ed16">score_</a>; }</div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="comment">// Returns the total deterministic time spend by the completed tasks before</span></div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="comment">// the last Synchronize() call.</span></div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_sub_solver.html#ae525d235b02bcfc962d845e28f5f0125"> 81</a></span> <span class="keywordtype">double</span> <a class="code hl_function" href="classoperations__research_1_1sat_1_1_sub_solver.html#ae525d235b02bcfc962d845e28f5f0125">deterministic_time</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classoperations__research_1_1sat_1_1_sub_solver.html#ac05d8d7f6bf4c0144398514cc334d237">deterministic_time_</a>; }</div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// Returns the name of this SubSolver. Used in logs.</span></div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_sub_solver.html#a1d89c28bd42ba9a52da008bb69367171"> 84</a></span> std::string <a class="code hl_function" href="classoperations__research_1_1sat_1_1_sub_solver.html#a1d89c28bd42ba9a52da008bb69367171">name</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classoperations__research_1_1sat_1_1_sub_solver.html#a723d30392e2c4f36252de0528a1b246d">name_</a>; }</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="comment">// Returns search statistics.</span></div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_sub_solver.html#a9748e397e28a0cb3278729d476cc3eb8"> 87</a></span> <span class="keyword">virtual</span> std::string <a class="code hl_function" href="classoperations__research_1_1sat_1_1_sub_solver.html#a9748e397e28a0cb3278729d476cc3eb8">StatisticsString</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> std::string(); }</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_sub_solver.html#a723d30392e2c4f36252de0528a1b246d"> 90</a></span> <span class="keyword">const</span> std::string <a class="code hl_variable" href="classoperations__research_1_1sat_1_1_sub_solver.html#a723d30392e2c4f36252de0528a1b246d">name_</a>;</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_sub_solver.html#ae8a019e95b21b6721e045ec56589ed16"> 91</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="classoperations__research_1_1sat_1_1_sub_solver.html#ae8a019e95b21b6721e045ec56589ed16">score_</a> = 0.0;</div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_sub_solver.html#ac05d8d7f6bf4c0144398514cc334d237"> 92</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="classoperations__research_1_1sat_1_1_sub_solver.html#ac05d8d7f6bf4c0144398514cc334d237">deterministic_time_</a> = 0.0;</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> </div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="comment">// A simple wrapper to add a synchronization point in the list of subsolvers.</span></div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_synchronization_point.html"> 96</a></span><span class="keyword">class </span><a class="code hl_class" href="classoperations__research_1_1sat_1_1_synchronization_point.html">SynchronizationPoint</a> : <span class="keyword">public</span> <a class="code hl_class" href="classoperations__research_1_1sat_1_1_sub_solver.html">SubSolver</a> {</div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_synchronization_point.html#a8e26568e9054f7d3880c62cf50b0cdf1"> 98</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classoperations__research_1_1sat_1_1_synchronization_point.html#a8e26568e9054f7d3880c62cf50b0cdf1">SynchronizationPoint</a>(std::function<<span class="keywordtype">void</span>()> f)</div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> : <a class="code hl_class" href="classoperations__research_1_1sat_1_1_sub_solver.html">SubSolver</a>(<span class="stringliteral">""</span>), f_(<a class="code hl_namespace" href="namespacestd.html">std</a>::move(f)) {}</div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_synchronization_point.html#aa4f61b1e450540d3a66ef49ef35fd1d4"> 100</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classoperations__research_1_1sat_1_1_synchronization_point.html#aa4f61b1e450540d3a66ef49ef35fd1d4">TaskIsAvailable</a>() final { <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_synchronization_point.html#adf82dc566700687f9c7e9cb6e7ae3a45"> 101</a></span> std::function<void()> <a class="code hl_function" href="classoperations__research_1_1sat_1_1_synchronization_point.html#adf82dc566700687f9c7e9cb6e7ae3a45">GenerateTask</a>(int64_t task_id) <span class="keyword">final</span> { <span class="keywordflow">return</span> <span class="keyword">nullptr</span>; }</div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="classoperations__research_1_1sat_1_1_synchronization_point.html#aad936f0a60794f472d82278a9723d0d4"> 102</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1sat_1_1_synchronization_point.html#aad936f0a60794f472d82278a9723d0d4">Synchronize</a>() final { f_(); }</div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> std::function<void()> f_;</div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span>};</div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="comment">// Executes the following loop:</span></div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment">// 1/ Synchronize all in given order.</span></div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="comment">// 2/ generate and schedule one task from the current "best" subsolver.</span></div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="comment">// 3/ repeat until no extra task can be generated and all tasks are done.</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">// The complexity of each selection is in O(num_subsolvers), but that should</span></div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="comment">// be okay given that we don't expect more than 100 such subsolvers.</span></div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="comment">// Note that it is okay to incorporate "special" subsolver that never produce</span></div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="comment">// any tasks. This can be used to synchronize classes used by many subsolvers</span></div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="comment">// just once for instance.</span></div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceoperations__research_1_1sat.html#a5c75377277a8fab8caa3d53c17ecf7fd">NonDeterministicLoop</a>(</div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keyword">const</span> std::vector<std::unique_ptr<SubSolver>>& subsolvers, <span class="keywordtype">int</span> num_threads);</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><span class="comment">// Similar to NonDeterministicLoop() except this should result in a</span></div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span><span class="comment">// deterministic solver provided that all SubSolver respect the Synchronize()</span></div>
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="comment">// contract.</span></div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="comment">// Executes the following loop:</span></div>
|
|
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="comment">// 1/ Synchronize all in given order.</span></div>
|
|
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="comment">// 2/ generate and schedule up to batch_size tasks using an heuristic to select</span></div>
|
|
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="comment">// which one to run.</span></div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><span class="comment">// 3/ wait for all task to finish.</span></div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><span class="comment">// 4/ repeat until no task can be generated in step 2.</span></div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceoperations__research_1_1sat.html#a0b26de551c3b5b1831568f623f66cb16">DeterministicLoop</a>(</div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> <span class="keyword">const</span> std::vector<std::unique_ptr<SubSolver>>& subsolvers, <span class="keywordtype">int</span> num_threads,</div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keywordtype">int</span> batch_size);</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">// Same as above, but specialized implementation for the case num_threads=1.</span></div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span><span class="comment">// This avoids using a Threadpool altogether. It should have the same behavior</span></div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><span class="comment">// than the functions above with num_threads=1 and batch_size=1. Note that an</span></div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span><span class="comment">// higher batch size will not behave in the same way, even if num_threads=1.</span></div>
|
|
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceoperations__research_1_1sat.html#a26ef0827825a2b0d2e2352c5d2452511">SequentialLoop</a>(<span class="keyword">const</span> std::vector<std::unique_ptr<SubSolver>>& subsolvers);</div>
|
|
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> </div>
|
|
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span>} <span class="comment">// namespace sat</span></div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span>} <span class="comment">// namespace operations_research</span></div>
|
|
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> </div>
|
|
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span><span class="preprocessor">#endif </span><span class="comment">// OR_TOOLS_SAT_SUBSOLVER_H_</span></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_sub_solver_html"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_sub_solver.html">operations_research::sat::SubSolver</a></div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00041">subsolver.h:41</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_sub_solver_html_a1754d73c22a8492998b642c9d8df907a"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_sub_solver.html#a1754d73c22a8492998b642c9d8df907a">operations_research::sat::SubSolver::TaskIsAvailable</a></div><div class="ttdeci">virtual bool TaskIsAvailable()=0</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_sub_solver_html_a1d89c28bd42ba9a52da008bb69367171"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_sub_solver.html#a1d89c28bd42ba9a52da008bb69367171">operations_research::sat::SubSolver::name</a></div><div class="ttdeci">std::string name() const</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00084">subsolver.h:84</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_sub_solver_html_a321c6d764d7a95cb82eea2a0e1198028"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_sub_solver.html#a321c6d764d7a95cb82eea2a0e1198028">operations_research::sat::SubSolver::score</a></div><div class="ttdeci">double score() const</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00077">subsolver.h:77</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_sub_solver_html_a5b73fdbea9375b397b31686866d7fdec"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_sub_solver.html#a5b73fdbea9375b397b31686866d7fdec">operations_research::sat::SubSolver::~SubSolver</a></div><div class="ttdeci">virtual ~SubSolver()</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00044">subsolver.h:44</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_sub_solver_html_a723d30392e2c4f36252de0528a1b246d"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_sub_solver.html#a723d30392e2c4f36252de0528a1b246d">operations_research::sat::SubSolver::name_</a></div><div class="ttdeci">const std::string name_</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00090">subsolver.h:90</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_sub_solver_html_a9748e397e28a0cb3278729d476cc3eb8"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_sub_solver.html#a9748e397e28a0cb3278729d476cc3eb8">operations_research::sat::SubSolver::StatisticsString</a></div><div class="ttdeci">virtual std::string StatisticsString() const</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00087">subsolver.h:87</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_sub_solver_html_aa0b5c5345729a33212c0deae55d14354"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_sub_solver.html#aa0b5c5345729a33212c0deae55d14354">operations_research::sat::SubSolver::GenerateTask</a></div><div class="ttdeci">virtual std::function< void()> GenerateTask(int64_t task_id)=0</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_sub_solver_html_ac05d8d7f6bf4c0144398514cc334d237"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_sub_solver.html#ac05d8d7f6bf4c0144398514cc334d237">operations_research::sat::SubSolver::deterministic_time_</a></div><div class="ttdeci">double deterministic_time_</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00092">subsolver.h:92</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_sub_solver_html_ad2e23c304e8cbcd373924635e0a2a9fa"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_sub_solver.html#ad2e23c304e8cbcd373924635e0a2a9fa">operations_research::sat::SubSolver::SubSolver</a></div><div class="ttdeci">SubSolver(const std::string &name)</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00043">subsolver.h:43</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_sub_solver_html_ae13c194d355f54c75f87897e3c5beb6b"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_sub_solver.html#ae13c194d355f54c75f87897e3c5beb6b">operations_research::sat::SubSolver::Synchronize</a></div><div class="ttdeci">virtual void Synchronize()=0</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_sub_solver_html_ae525d235b02bcfc962d845e28f5f0125"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_sub_solver.html#ae525d235b02bcfc962d845e28f5f0125">operations_research::sat::SubSolver::deterministic_time</a></div><div class="ttdeci">double deterministic_time() const</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00081">subsolver.h:81</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_sub_solver_html_ae8a019e95b21b6721e045ec56589ed16"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_sub_solver.html#ae8a019e95b21b6721e045ec56589ed16">operations_research::sat::SubSolver::score_</a></div><div class="ttdeci">double score_</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00091">subsolver.h:91</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_synchronization_point_html"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_synchronization_point.html">operations_research::sat::SynchronizationPoint</a></div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00096">subsolver.h:96</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_synchronization_point_html_a8e26568e9054f7d3880c62cf50b0cdf1"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_synchronization_point.html#a8e26568e9054f7d3880c62cf50b0cdf1">operations_research::sat::SynchronizationPoint::SynchronizationPoint</a></div><div class="ttdeci">SynchronizationPoint(std::function< void()> f)</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00098">subsolver.h:98</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_synchronization_point_html_aa4f61b1e450540d3a66ef49ef35fd1d4"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_synchronization_point.html#aa4f61b1e450540d3a66ef49ef35fd1d4">operations_research::sat::SynchronizationPoint::TaskIsAvailable</a></div><div class="ttdeci">bool TaskIsAvailable() final</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00100">subsolver.h:100</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_synchronization_point_html_aad936f0a60794f472d82278a9723d0d4"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_synchronization_point.html#aad936f0a60794f472d82278a9723d0d4">operations_research::sat::SynchronizationPoint::Synchronize</a></div><div class="ttdeci">void Synchronize() final</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00102">subsolver.h:102</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_synchronization_point_html_adf82dc566700687f9c7e9cb6e7ae3a45"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_synchronization_point.html#adf82dc566700687f9c7e9cb6e7ae3a45">operations_research::sat::SynchronizationPoint::GenerateTask</a></div><div class="ttdeci">std::function< void()> GenerateTask(int64_t task_id) final</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8h_source.html#l00101">subsolver.h:101</a></div></div>
|
|
<div class="ttc" id="aintegral__types_8h_html"><div class="ttname"><a href="integral__types_8h.html">integral_types.h</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1sat_html_a0b26de551c3b5b1831568f623f66cb16"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#a0b26de551c3b5b1831568f623f66cb16">operations_research::sat::DeterministicLoop</a></div><div class="ttdeci">void DeterministicLoop(const std::vector< std::unique_ptr< SubSolver > > &subsolvers, int num_threads, int batch_size)</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8cc_source.html#l00086">subsolver.cc:86</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1sat_html_a26ef0827825a2b0d2e2352c5d2452511"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#a26ef0827825a2b0d2e2352c5d2452511">operations_research::sat::SequentialLoop</a></div><div class="ttdeci">void SequentialLoop(const std::vector< std::unique_ptr< SubSolver > > &subsolvers)</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8cc_source.html#l00056">subsolver.cc:56</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1sat_html_a5c75377277a8fab8caa3d53c17ecf7fd"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#a5c75377277a8fab8caa3d53c17ecf7fd">operations_research::sat::NonDeterministicLoop</a></div><div class="ttdeci">void NonDeterministicLoop(const std::vector< std::unique_ptr< SubSolver > > &subsolvers, int num_threads)</div><div class="ttdef"><b>Definition:</b> <a href="subsolver_8cc_source.html#l00118">subsolver.cc:118</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="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdoc">STL namespace.</div></div>
|
|
<div class="ttc" id="athreadpool_8h_html"><div class="ttname"><a href="threadpool_8h.html">threadpool.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_dddac007a45022d9da6ea1dee012c3b9.html">sat</a></li><li class="navelem"><a class="el" href="subsolver_8h.html">subsolver.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>
|