283 lines
44 KiB
HTML
283 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.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: solver_interface.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.2</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('solver__interface_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">solver_interface.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="solver__interface_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2010-2021 Google LLC</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// You may obtain a copy of the License at</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// limitations under the License.</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#ifndef OR_TOOLS_MATH_OPT_CORE_SOLVER_INTERFACE_H_</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#define OR_TOOLS_MATH_OPT_CORE_SOLVER_INTERFACE_H_</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include <functional></span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include <vector></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 "absl/container/flat_hash_map.h"</span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include "absl/status/status.h"</span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include "absl/status/statusor.h"</span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include "absl/synchronization/mutex.h"</span></div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include "ortools/math_opt/callback.pb.h"</span></div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include "ortools/math_opt/model.pb.h"</span></div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include "ortools/math_opt/model_parameters.pb.h"</span></div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "ortools/math_opt/model_update.pb.h"</span></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "ortools/math_opt/parameters.pb.h"</span></div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include "ortools/math_opt/result.pb.h"</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>math_opt {</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">// Interface implemented by actual solvers.</span></div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment">// This interface is not meant to be used directly. The actual API is the one of</span></div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment">// the Solver class. The Solver class validates the models before calling this</span></div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">// interface.</span></div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment">// Implementations of this interface should not have public constructors but</span></div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">// instead have a static `New` function with the signature of Factory function</span></div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment">// as defined below. They should register this factory using the macro</span></div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment">// MATH_OPT_REGISTER_SOLVER().</span></div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solver_interface.html"> 46</a></span><span class="keyword">class </span><a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_solver_interface.html">SolverInterface</a> {</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// A callback function (if non null) is a function that validates its input</span></div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// and its output, and if fails, return a status. The invariant is that the</span></div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// solver implementation can rely on receiving valid data. The implementation</span></div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// of this interface must provide valid input (which will be validated) and</span></div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// in error, it will return a status (without actually calling the callback</span></div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// function). This is enforced in the solver.cc layer.</span></div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ab47a61ca53ae9cdf35dd4f2dfc9ecadb"> 54</a></span> <span class="keyword">using</span> <a class="code hl_typedef" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ab47a61ca53ae9cdf35dd4f2dfc9ecadb">Callback</a> = std::function<absl::StatusOr<CallbackResultProto>(</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">const</span> CallbackDataProto&)>;</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="comment">// A factory builds a solver based on the input model and parameters.</span></div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// Implementation should have a static `New()` function with this signature</span></div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// and no public constructors.</span></div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// The implementation should assume the input ModelProto is valid and is free</span></div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="comment">// to CHECK-fail if this is not the case.</span></div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ad44289e368657b6706160eae15313ae6"> 64</a></span> <span class="keyword">using</span> <a class="code hl_typedef" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ad44289e368657b6706160eae15313ae6">Factory</a> =</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> std::function<absl::StatusOr<std::unique_ptr<SolverInterface>>(</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">const</span> ModelProto& <a class="code hl_variable" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>, <span class="keyword">const</span> SolverInitializerProto& initializer)>;</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ad1e9901f628f2e89a05af97d0dd4c57c"> 68</a></span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ad1e9901f628f2e89a05af97d0dd4c57c">SolverInterface</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ae9b1880991b1fc732485c99036790983"> 69</a></span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ae9b1880991b1fc732485c99036790983">SolverInterface</a>(<span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_solver_interface.html">SolverInterface</a>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#a1c13d92bfd97bfc6825f7de8cde8997b"> 70</a></span> <a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_solver_interface.html">SolverInterface</a>& <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#a1c13d92bfd97bfc6825f7de8cde8997b">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_solver_interface.html">SolverInterface</a>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#a6e8dbe2e0376ea1072889f124347c7df"> 71</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#a6e8dbe2e0376ea1072889f124347c7df">~SolverInterface</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// Solves the current model (included all updates).</span></div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// All input arguments are ensured (by solver.cc) to be valid. Furthermore,</span></div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// since all parameters are references or functions (which could be a lambda</span></div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="comment">// expression), the implementation should not keep a reference or copy of</span></div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="comment">// them, as they may become invalid reference after the invocation if this</span></div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="comment">// function.</span></div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#a9030d622469d1d352ef62aae6bff7c5d"> 80</a></span> <span class="keyword">virtual</span> absl::StatusOr<SolveResultProto> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#a9030d622469d1d352ef62aae6bff7c5d">Solve</a>(</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keyword">const</span> SolveParametersProto& <a class="code hl_variable" href="cp__model__fz__solver_8cc.html#a10a1eab179b472c030bdc2a2efef7219">parameters</a>,</div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">const</span> ModelSolveParametersProto& model_parameters,</div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">const</span> CallbackRegistrationProto& callback_registration, <a class="code hl_typedef" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ab47a61ca53ae9cdf35dd4f2dfc9ecadb">Callback</a> cb) = 0;</div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// Updates the model to solve.</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">// The implementation should assume the input ModelUpdate is valid and is free</span></div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// to assert if this is not the case.</span></div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#a0b2421a582a4317b26d0446781119f4d"> 89</a></span> <span class="keyword">virtual</span> absl::Status <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#a0b2421a582a4317b26d0446781119f4d">Update</a>(<span class="keyword">const</span> ModelUpdateProto& model_update) = 0;</div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="comment">// Return true if this solver can handle the given update.</span></div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="comment">// The implementation should assume the input ModelUpdate is valid and is free</span></div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="comment">// to assert if this is not the case.</span></div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ad8b1e514f2b213b3fd4085683d20ff54"> 95</a></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ad8b1e514f2b213b3fd4085683d20ff54">CanUpdate</a>(<span class="keyword">const</span> ModelUpdateProto& model_update) = 0;</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> </div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html"> 98</a></span><span class="keyword">class </span><a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html">AllSolversRegistry</a> {</div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#a157c3997d9a0b7a1b789f447273b83ea"> 100</a></span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#a157c3997d9a0b7a1b789f447273b83ea">AllSolversRegistry</a>(<span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html">AllSolversRegistry</a>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#aa9032e3fbde11f67eec1588456e408e9"> 101</a></span> <a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html">AllSolversRegistry</a>& <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#aa9032e3fbde11f67eec1588456e408e9">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html">AllSolversRegistry</a>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">static</span> <a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html">AllSolversRegistry</a>* <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#ab14e7952908d0b84f0229f4facac936c">Instance</a>();</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">// Maps the given factory to the given solver type. Calling this twice will</span></div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="comment">// result in an error, using static initialization is recommended, e.g. see</span></div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <span class="comment">// MATH_OPT_REGISTER_SOLVER defined below.</span></div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="comment">// Required: factory must be threadsafe.</span></div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#ad14cff326f6d83749e274d8b4b09b031">Register</a>(SolverType solver_type, <a class="code hl_typedef" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ad44289e368657b6706160eae15313ae6">SolverInterface::Factory</a> factory);</div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="comment">// Invokes the factory associated to the solver type with the provided</span></div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="comment">// arguments.</span></div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> absl::StatusOr<std::unique_ptr<SolverInterface>> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#ae1a34fd7a48051d9f87f2703c4e6afcf">Create</a>(</div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> SolverType solver_type, <span class="keyword">const</span> ModelProto& <a class="code hl_variable" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>,</div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="keyword">const</span> SolverInitializerProto& initializer) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="comment">// Whether a solver type is supported.</span></div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#ab4f4a888035210f4732e397430df74e3">IsRegistered</a>(SolverType solver_type) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
|
|
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <span class="comment">// List all supported solver types.</span></div>
|
|
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> std::vector<SolverType> <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#a9c66233d84a474617058fbfd40d66417">RegisteredSolvers</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> </div>
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <span class="comment">// Returns a human-readable list of supported solver types.</span></div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> std::string <a class="code hl_function" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#a9c32ef3022cd0c9999df129ed9c5bfb1">RegisteredSolversToString</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
|
|
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <a class="code hl_class" href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html">AllSolversRegistry</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> </div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <span class="keyword">mutable</span> absl::Mutex mutex_;</div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> absl::flat_hash_map<SolverType, SolverInterface::Factory> registered_solvers_;</div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span>};</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="comment">// Use to ensure that a solver is registered exactly one time. Invoke in each cc</span></div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span><span class="comment">// file implementing a SolverInterface. Example use:</span></div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span><span class="comment">// MATH_OPT_REGISTER_SOLVER(SOLVER_TYPE_GSCIP, GScipSolver::New)</span></div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span><span class="comment">// Can only be used once per cc file.</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">// Arguments:</span></div>
|
|
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span><span class="comment">// solver_type: A SolverType proto enum.</span></div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span><span class="comment">// solver_factory: A SolverInterface::Factory for solver_type.</span></div>
|
|
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"><a class="line" href="solver__interface_8h.html#ad082a79cf1be23f55e3435fad5bf4949"> 144</a></span><span class="preprocessor">#define MATH_OPT_REGISTER_SOLVER(solver_type, solver_factory) \</span></div>
|
|
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span><span class="preprocessor"> namespace { \</span></div>
|
|
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span><span class="preprocessor"> const void* const kRegisterSolver ABSL_ATTRIBUTE_UNUSED = [] { \</span></div>
|
|
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span><span class="preprocessor"> AllSolversRegistry::Instance()->Register(solver_type, solver_factory); \</span></div>
|
|
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span><span class="preprocessor"> return nullptr; \</span></div>
|
|
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span><span class="preprocessor"> }(); \</span></div>
|
|
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span><span class="preprocessor"> } </span><span class="comment">// namespace</span></div>
|
|
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> </div>
|
|
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span>} <span class="comment">// namespace math_opt</span></div>
|
|
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span>} <span class="comment">// namespace operations_research</span></div>
|
|
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> </div>
|
|
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span><span class="preprocessor">#endif </span><span class="comment">// OR_TOOLS_MATH_OPT_CORE_SOLVER_INTERFACE_H_</span></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_all_solvers_registry_html"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html">operations_research::math_opt::AllSolversRegistry</a></div><div class="ttdef"><b>Definition:</b> <a href="solver__interface_8h_source.html#l00098">solver_interface.h:98</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_all_solvers_registry_html_a157c3997d9a0b7a1b789f447273b83ea"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#a157c3997d9a0b7a1b789f447273b83ea">operations_research::math_opt::AllSolversRegistry::AllSolversRegistry</a></div><div class="ttdeci">AllSolversRegistry(const AllSolversRegistry &)=delete</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_all_solvers_registry_html_a9c32ef3022cd0c9999df129ed9c5bfb1"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#a9c32ef3022cd0c9999df129ed9c5bfb1">operations_research::math_opt::AllSolversRegistry::RegisteredSolversToString</a></div><div class="ttdeci">std::string RegisteredSolversToString() const</div><div class="ttdef"><b>Definition:</b> <a href="solver__interface_8cc_source.html#l00087">solver_interface.cc:87</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_all_solvers_registry_html_a9c66233d84a474617058fbfd40d66417"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#a9c66233d84a474617058fbfd40d66417">operations_research::math_opt::AllSolversRegistry::RegisteredSolvers</a></div><div class="ttdeci">std::vector< SolverType > RegisteredSolvers() const</div><div class="ttdef"><b>Definition:</b> <a href="solver__interface_8cc_source.html#l00075">solver_interface.cc:75</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_all_solvers_registry_html_aa9032e3fbde11f67eec1588456e408e9"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#aa9032e3fbde11f67eec1588456e408e9">operations_research::math_opt::AllSolversRegistry::operator=</a></div><div class="ttdeci">AllSolversRegistry & operator=(const AllSolversRegistry &)=delete</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_all_solvers_registry_html_ab14e7952908d0b84f0229f4facac936c"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#ab14e7952908d0b84f0229f4facac936c">operations_research::math_opt::AllSolversRegistry::Instance</a></div><div class="ttdeci">static AllSolversRegistry * Instance()</div><div class="ttdef"><b>Definition:</b> <a href="solver__interface_8cc_source.html#l00037">solver_interface.cc:37</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_all_solvers_registry_html_ab4f4a888035210f4732e397430df74e3"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#ab4f4a888035210f4732e397430df74e3">operations_research::math_opt::AllSolversRegistry::IsRegistered</a></div><div class="ttdeci">bool IsRegistered(SolverType solver_type) const</div><div class="ttdef"><b>Definition:</b> <a href="solver__interface_8cc_source.html#l00070">solver_interface.cc:70</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_all_solvers_registry_html_ad14cff326f6d83749e274d8b4b09b031"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#ad14cff326f6d83749e274d8b4b09b031">operations_research::math_opt::AllSolversRegistry::Register</a></div><div class="ttdeci">void Register(SolverType solver_type, SolverInterface::Factory factory)</div><div class="ttdef"><b>Definition:</b> <a href="solver__interface_8cc_source.html#l00042">solver_interface.cc:42</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_all_solvers_registry_html_ae1a34fd7a48051d9f87f2703c4e6afcf"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_all_solvers_registry.html#ae1a34fd7a48051d9f87f2703c4e6afcf">operations_research::math_opt::AllSolversRegistry::Create</a></div><div class="ttdeci">absl::StatusOr< std::unique_ptr< SolverInterface > > Create(SolverType solver_type, const ModelProto &model, const SolverInitializerProto &initializer) const</div><div class="ttdef"><b>Definition:</b> <a href="solver__interface_8cc_source.html#l00054">solver_interface.cc:54</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solver_interface_html"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solver_interface.html">operations_research::math_opt::SolverInterface</a></div><div class="ttdef"><b>Definition:</b> <a href="solver__interface_8h_source.html#l00046">solver_interface.h:46</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solver_interface_html_a0b2421a582a4317b26d0446781119f4d"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solver_interface.html#a0b2421a582a4317b26d0446781119f4d">operations_research::math_opt::SolverInterface::Update</a></div><div class="ttdeci">virtual absl::Status Update(const ModelUpdateProto &model_update)=0</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solver_interface_html_a1c13d92bfd97bfc6825f7de8cde8997b"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solver_interface.html#a1c13d92bfd97bfc6825f7de8cde8997b">operations_research::math_opt::SolverInterface::operator=</a></div><div class="ttdeci">SolverInterface & operator=(const SolverInterface &)=delete</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solver_interface_html_a6e8dbe2e0376ea1072889f124347c7df"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solver_interface.html#a6e8dbe2e0376ea1072889f124347c7df">operations_research::math_opt::SolverInterface::~SolverInterface</a></div><div class="ttdeci">virtual ~SolverInterface()=default</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solver_interface_html_a9030d622469d1d352ef62aae6bff7c5d"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solver_interface.html#a9030d622469d1d352ef62aae6bff7c5d">operations_research::math_opt::SolverInterface::Solve</a></div><div class="ttdeci">virtual absl::StatusOr< SolveResultProto > Solve(const SolveParametersProto &parameters, const ModelSolveParametersProto &model_parameters, const CallbackRegistrationProto &callback_registration, Callback cb)=0</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="aclassoperations__research_1_1math__opt_1_1_solver_interface_html_ad1e9901f628f2e89a05af97d0dd4c57c"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ad1e9901f628f2e89a05af97d0dd4c57c">operations_research::math_opt::SolverInterface::SolverInterface</a></div><div class="ttdeci">SolverInterface()=default</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solver_interface_html_ad44289e368657b6706160eae15313ae6"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ad44289e368657b6706160eae15313ae6">operations_research::math_opt::SolverInterface::Factory</a></div><div class="ttdeci">std::function< absl::StatusOr< std::unique_ptr< SolverInterface > >(const ModelProto &model, const SolverInitializerProto &initializer)> Factory</div><div class="ttdef"><b>Definition:</b> <a href="solver__interface_8h_source.html#l00064">solver_interface.h:66</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solver_interface_html_ad8b1e514f2b213b3fd4085683d20ff54"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ad8b1e514f2b213b3fd4085683d20ff54">operations_research::math_opt::SolverInterface::CanUpdate</a></div><div class="ttdeci">virtual bool CanUpdate(const ModelUpdateProto &model_update)=0</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1math__opt_1_1_solver_interface_html_ae9b1880991b1fc732485c99036790983"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ae9b1880991b1fc732485c99036790983">operations_research::math_opt::SolverInterface::SolverInterface</a></div><div class="ttdeci">SolverInterface(const SolverInterface &)=delete</div></div>
|
|
<div class="ttc" id="acp__model__fz__solver_8cc_html_a10a1eab179b472c030bdc2a2efef7219"><div class="ttname"><a href="cp__model__fz__solver_8cc.html#a10a1eab179b472c030bdc2a2efef7219">parameters</a></div><div class="ttdeci">SatParameters parameters</div><div class="ttdef"><b>Definition:</b> <a href="cp__model__fz__solver_8cc_source.html#l00120">cp_model_fz_solver.cc:120</a></div></div>
|
|
<div class="ttc" id="agurobi__interface_8cc_html_a0728f23c9a47655d38e0bf1a2f200bcf"><div class="ttname"><a href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a></div><div class="ttdeci">GRBmodel * model</div><div class="ttdef"><b>Definition:</b> <a href="gurobi__interface_8cc_source.html#l00274">gurobi_interface.cc:274</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><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.18-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_1defc00030ff81d309105e053121082f.html">math_opt</a></li><li class="navelem"><a class="el" href="dir_d5b95ec3710e8b09bb3a6564ed5074d8.html">core</a></li><li class="navelem"><a class="el" href="solver__interface_8h.html">solver_interface.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>
|