Files
ortools-clone/docs/cpp/solver_8cc_source.html
Laurent Perron a2ad6677e1 regenerate doc
2022-01-16 18:02:36 +01:00

142 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.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: solver.cc Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('solver_8cc_source.html','');});
/* @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.cc</div> </div>
</div><!--header-->
<div class="contents">
<a href="solver_8cc.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2010-2021 Google LLC</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// limitations under the License.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="solver_8h.html">ortools/math_opt/core/solver.h</a>&quot;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;functional&gt;</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="integral__types_8h.html">ortools/base/integral_types.h</a>&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="base_2logging_8h.html">ortools/base/logging.h</a>&quot;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;absl/memory/memory.h&quot;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;absl/status/status.h&quot;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;absl/status/statusor.h&quot;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;absl/types/span.h&quot;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;ortools/math_opt/callback.pb.h&quot;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="model__summary_8h.html">ortools/math_opt/core/model_summary.h</a>&quot;</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="solver__interface_8h.html">ortools/math_opt/core/solver_interface.h</a>&quot;</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &quot;ortools/math_opt/model.pb.h&quot;</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &quot;ortools/math_opt/model_parameters.pb.h&quot;</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#include &quot;ortools/math_opt/model_update.pb.h&quot;</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#include &quot;ortools/math_opt/parameters.pb.h&quot;</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#include &quot;ortools/math_opt/result.pb.h&quot;</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="callback__validator_8h.html">ortools/math_opt/validators/callback_validator.h</a>&quot;</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="model__parameters__validator_8h.html">ortools/math_opt/validators/model_parameters_validator.h</a>&quot;</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="math__opt_2validators_2model__validator_8h.html">ortools/math_opt/validators/model_validator.h</a>&quot;</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="solution__validator_8h.html">ortools/math_opt/validators/solution_validator.h</a>&quot;</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="solver__parameters__validator_8h.html">ortools/math_opt/validators/solver_parameters_validator.h</a>&quot;</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="status__macros_8h.html">ortools/base/status_macros.h</a>&quot;</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceoperations__research.html">operations_research</a> {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword">namespace </span>math_opt {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keyword">namespace </span>{</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IdNameContainer&gt;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keywordtype">void</span> UpdateIdNameMap(<span class="keyword">const</span> absl::Span&lt;const int64_t&gt; deleted_ids,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">const</span> IdNameContainer&amp; container, IdNameBiMap&amp; bimap) {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> int64_t deleted_id : deleted_ids) {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; bimap.Erase(deleted_id);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; container.ids_size(); ++i) {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; std::string <a class="code" href="default__search_8cc.html#ac673bc430bdc3fdaa09f7becf98ef267">name</a>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">if</span> (!container.names().empty()) {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="default__search_8cc.html#ac673bc430bdc3fdaa09f7becf98ef267">name</a> = container.names(i);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; bimap.Insert(container.ids(i), std::move(<a class="code" href="default__search_8cc.html#ac673bc430bdc3fdaa09f7becf98ef267">name</a>));</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;}</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;ModelSummary MakeSummary(<span class="keyword">const</span> ModelProto&amp; <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>) {</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; ModelSummary summary;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; UpdateIdNameMap&lt;VariablesProto&gt;({}, <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>.variables(), summary.variables);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; UpdateIdNameMap&lt;LinearConstraintsProto&gt;({}, <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>.linear_constraints(),</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; summary.linear_constraints);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordflow">return</span> summary;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;}</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="keywordtype">void</span> UpdateSummaryFromModelUpdate(<span class="keyword">const</span> ModelUpdateProto&amp; model_update,</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; ModelSummary&amp; summary) {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; UpdateIdNameMap&lt;VariablesProto&gt;(model_update.deleted_variable_ids(),</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; model_update.new_variables(),</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; summary.variables);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; UpdateIdNameMap&lt;LinearConstraintsProto&gt;(</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; model_update.deleted_linear_constraint_ids(),</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; model_update.new_linear_constraints(), summary.linear_constraints);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;}</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment">// Returns an InternalError with the input status message if the input status is</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="comment">// not OK.</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;absl::Status ToInternalError(<span class="keyword">const</span> absl::Status original) {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordflow">if</span> (original.ok()) {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">return</span> original;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordflow">return</span> absl::InternalError(original.message());</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;}</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;} <span class="comment">// namespace</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<a class="code" href="classoperations__research_1_1math__opt_1_1_solver.html#ac3d73bcaa7a8494c030cfbd182a89f02">Solver::Solver</a>(std::unique_ptr&lt;SolverInterface&gt; underlying_solver,</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; ModelSummary model_summary)</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; : underlying_solver_(std::move(underlying_solver)),</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; model_summary_(std::move(model_summary)) {</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <a class="code" href="base_2logging_8h.html#a3e1cfef60e774a81f30eaddf26a3a274">CHECK</a>(underlying_solver_ != <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;}</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solver.html#afa9095b39ffb466b7a8d8dcece9a455e"> 101</a></span>&#160;absl::StatusOr&lt;std::unique_ptr&lt;Solver&gt;&gt; Solver::New(</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keyword">const</span> SolverType solver_type, <span class="keyword">const</span> ModelProto&amp; <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>,</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">const</span> SolverInitializerProto&amp; initializer) {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <a class="code" href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a>(<a class="code" href="namespaceoperations__research_1_1math__opt.html#af039565f98410c47887cc13d5dbdd31b">ValidateModel</a>(<a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>));</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <a class="code" href="status__macros_8h.html#a600de4b8f65fe0a4b1898041634f9011">ASSIGN_OR_RETURN</a>(</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">auto</span> underlying_solver,</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; AllSolversRegistry::Instance()-&gt;Create(solver_type, <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>, initializer));</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keyword">auto</span> result = absl::WrapUnique(</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">new</span> <a class="code" href="classoperations__research_1_1_solver.html#abac10873a1af49f1dce33a34f3afaa56">Solver</a>(std::move(underlying_solver), MakeSummary(<a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>)));</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;}</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;</div><div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solver.html#abf5b2161b103c058cea47bbfd2683616"> 113</a></span>&#160;absl::StatusOr&lt;SolveResultProto&gt; <a class="code" href="classoperations__research_1_1_solver.html#a946780dfafc8faa3dd2d345850213be5">Solver::Solve</a>(</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keyword">const</span> SolveParametersProto&amp; <a class="code" href="cp__model__fz__solver_8cc.html#a10a1eab179b472c030bdc2a2efef7219">parameters</a>,</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keyword">const</span> ModelSolveParametersProto&amp; model_parameters,</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keyword">const</span> CallbackRegistrationProto&amp; callback_registration,</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keyword">const</span> <a class="code" href="classoperations__research_1_1math__opt_1_1_solver.html#acc33a9824afffd1de1d7c85906c5fd31">Callback</a> user_cb) {</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="comment">// TODO(b/168037341): we should validate the result maths. Since the result</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="comment">// can be filtered, this should be included in the solver_interface</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="comment">// implementations.</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <a class="code" href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a>(<a class="code" href="namespaceoperations__research_1_1math__opt.html#ab91fc238b75cc4908d380a32876551e9">ValidateSolverParameters</a>(<a class="code" href="classoperations__research_1_1_solver.html#a2a0b93a70f0d588f157ade7909c42eff">parameters</a>)) &lt;&lt; <span class="stringliteral">&quot;invalid parameters&quot;</span>;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <a class="code" href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a>(</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <a class="code" href="namespaceoperations__research_1_1math__opt.html#ac4c49167100d15c4aa49b054c180c56d">ValidateModelSolveParameters</a>(model_parameters, model_summary_))</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; &lt;&lt; <span class="stringliteral">&quot;invalid model_parameters&quot;</span>;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <a class="code" href="classoperations__research_1_1math__opt_1_1_solver_interface.html#ab47a61ca53ae9cdf35dd4f2dfc9ecadb">SolverInterface::Callback</a> cb = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordflow">if</span> (user_cb != <span class="keyword">nullptr</span>) {</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <a class="code" href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a>(</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <a class="code" href="namespaceoperations__research_1_1math__opt.html#a7abc01bd247a24b76cd5e58d141c7219">ValidateCallbackRegistration</a>(callback_registration, model_summary_));</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; cb = [&amp;](<span class="keyword">const</span> CallbackDataProto&amp; callback_data)</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; -&gt; absl::StatusOr&lt;CallbackResultProto&gt; {</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <a class="code" href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a>(<a class="code" href="namespaceoperations__research_1_1math__opt.html#a73642a8827dfec380f36678d0451730b">ValidateCallbackDataProto</a>(</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; callback_data, callback_registration, model_summary_));</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keyword">auto</span> callback_result = user_cb(callback_data);</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <a class="code" href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a>(</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <a class="code" href="namespaceoperations__research_1_1math__opt.html#a37e6d93b6f608edcfeb9c635c4f7b4bb">ValidateCallbackResultProto</a>(callback_result, callback_data.event(),</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; callback_registration, model_summary_));</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keywordflow">return</span> callback_result;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; };</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; }</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <a class="code" href="status__macros_8h.html#a600de4b8f65fe0a4b1898041634f9011">ASSIGN_OR_RETURN</a>(<span class="keyword">const</span> SolveResultProto result,</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; underlying_solver_-&gt;Solve(<a class="code" href="classoperations__research_1_1_solver.html#a2a0b93a70f0d588f157ade7909c42eff">parameters</a>, model_parameters,</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; callback_registration, cb));</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="comment">// We consider errors in `result` to be internal errors, but</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="comment">// `ValidateResult()` will return an InvalidArgumentError. So here we convert</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="comment">// the error.</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <a class="code" href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a>(ToInternalError(</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <a class="code" href="namespaceoperations__research_1_1math__opt.html#a056d48c0fb340c225fc0dfe023b102d4">ValidateResult</a>(result, model_parameters, model_summary_)));</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;}</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;</div><div class="line"><a name="l00156"></a><span class="lineno"><a class="line" href="classoperations__research_1_1math__opt_1_1_solver.html#afab112ee215257b1dce7b7deab8c2406"> 156</a></span>&#160;absl::StatusOr&lt;bool&gt; Solver::Update(<span class="keyword">const</span> ModelUpdateProto&amp; model_update) {</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <a class="code" href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a>(<a class="code" href="namespaceoperations__research_1_1math__opt.html#a140d4dcb13c7bce57fbded411ac905df">ValidateModelUpdateAndSummary</a>(model_update, model_summary_));</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; <span class="keywordflow">if</span> (!underlying_solver_-&gt;CanUpdate(model_update)) {</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; }</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; UpdateSummaryFromModelUpdate(model_update, model_summary_);</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; <a class="code" href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a>(underlying_solver_-&gt;Update(model_update));</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;}</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;} <span class="comment">// namespace math_opt</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;} <span class="comment">// namespace operations_research</span></div><div class="ttc" id="base_2logging_8h_html_a3e1cfef60e774a81f30eaddf26a3a274"><div class="ttname"><a href="base_2logging_8h.html#a3e1cfef60e774a81f30eaddf26a3a274">CHECK</a></div><div class="ttdeci">#define CHECK(condition)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00495">base/logging.h:495</a></div></div>
<div class="ttc" id="solver__parameters__validator_8h_html"><div class="ttname"><a href="solver__parameters__validator_8h.html">solver_parameters_validator.h</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_a7abc01bd247a24b76cd5e58d141c7219"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a7abc01bd247a24b76cd5e58d141c7219">operations_research::math_opt::ValidateCallbackRegistration</a></div><div class="ttdeci">absl::Status ValidateCallbackRegistration(const CallbackRegistrationProto &amp;callback_registration, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="callback__validator_8cc_source.html#l00099">callback_validator.cc:99</a></div></div>
<div class="ttc" id="classoperations__research_1_1_solver_html_abac10873a1af49f1dce33a34f3afaa56"><div class="ttname"><a href="classoperations__research_1_1_solver.html#abac10873a1af49f1dce33a34f3afaa56">operations_research::Solver::Solver</a></div><div class="ttdeci">Solver(const std::string &amp;name)</div><div class="ttdoc">Solver API.</div><div class="ttdef"><b>Definition:</b> <a href="constraint__solver_8cc_source.html#l01421">constraint_solver.cc:1421</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_a73642a8827dfec380f36678d0451730b"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a73642a8827dfec380f36678d0451730b">operations_research::math_opt::ValidateCallbackDataProto</a></div><div class="ttdeci">absl::Status ValidateCallbackDataProto(const CallbackDataProto &amp;cb_data, const CallbackRegistrationProto &amp;callback_registration, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="callback__validator_8cc_source.html#l00122">callback_validator.cc:122</a></div></div>
<div class="ttc" id="default__search_8cc_html_ac673bc430bdc3fdaa09f7becf98ef267"><div class="ttname"><a href="default__search_8cc.html#ac673bc430bdc3fdaa09f7becf98ef267">name</a></div><div class="ttdeci">const std::string name</div><div class="ttdef"><b>Definition:</b> <a href="default__search_8cc_source.html#l00813">default_search.cc:813</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_ac4c49167100d15c4aa49b054c180c56d"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#ac4c49167100d15c4aa49b054c180c56d">operations_research::math_opt::ValidateModelSolveParameters</a></div><div class="ttdeci">absl::Status ValidateModelSolveParameters(const ModelSolveParametersProto &amp;parameters, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="model__parameters__validator_8cc_source.html#l00048">model_parameters_validator.cc:48</a></div></div>
<div class="ttc" id="gurobi__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="model__parameters__validator_8h_html"><div class="ttname"><a href="model__parameters__validator_8h.html">model_parameters_validator.h</a></div></div>
<div class="ttc" id="integral__types_8h_html"><div class="ttname"><a href="integral__types_8h.html">integral_types.h</a></div></div>
<div class="ttc" id="classoperations__research_1_1_solver_html_a2a0b93a70f0d588f157ade7909c42eff"><div class="ttname"><a href="classoperations__research_1_1_solver.html#a2a0b93a70f0d588f157ade7909c42eff">operations_research::Solver::parameters</a></div><div class="ttdeci">ConstraintSolverParameters parameters() const</div><div class="ttdoc">Stored Parameters.</div><div class="ttdef"><b>Definition:</b> <a href="constraint__solver_8h_source.html#l00763">constraint_solver.h:763</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_a140d4dcb13c7bce57fbded411ac905df"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a140d4dcb13c7bce57fbded411ac905df">operations_research::math_opt::ValidateModelUpdateAndSummary</a></div><div class="ttdeci">absl::Status ValidateModelUpdateAndSummary(const ModelUpdateProto &amp;model_update, const ModelSummary &amp;model_summary, const bool check_names)</div><div class="ttdef"><b>Definition:</b> <a href="math__opt_2validators_2model__validator_8cc_source.html#l00298">math_opt/validators/model_validator.cc:298</a></div></div>
<div class="ttc" id="classoperations__research_1_1math__opt_1_1_solver_html_ac3d73bcaa7a8494c030cfbd182a89f02"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solver.html#ac3d73bcaa7a8494c030cfbd182a89f02">operations_research::math_opt::Solver::Solver</a></div><div class="ttdeci">Solver(const Solver &amp;)=delete</div></div>
<div class="ttc" id="solver_8h_html"><div class="ttname"><a href="solver_8h.html">solver.h</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_a056d48c0fb340c225fc0dfe023b102d4"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a056d48c0fb340c225fc0dfe023b102d4">operations_research::math_opt::ValidateResult</a></div><div class="ttdeci">absl::Status ValidateResult(const SolveResultProto &amp;result, const ModelSolveParametersProto &amp;parameters, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="solution__validator_8cc_source.html#l00043">solution_validator.cc:43</a></div></div>
<div class="ttc" id="base_2logging_8h_html"><div class="ttname"><a href="base_2logging_8h.html">logging.h</a></div></div>
<div class="ttc" id="model__summary_8h_html"><div class="ttname"><a href="model__summary_8h.html">model_summary.h</a></div></div>
<div class="ttc" id="classoperations__research_1_1math__opt_1_1_solver_html_acc33a9824afffd1de1d7c85906c5fd31"><div class="ttname"><a href="classoperations__research_1_1math__opt_1_1_solver.html#acc33a9824afffd1de1d7c85906c5fd31">operations_research::math_opt::Solver::Callback</a></div><div class="ttdeci">std::function&lt; CallbackResultProto(const CallbackDataProto &amp;)&gt; Callback</div><div class="ttdef"><b>Definition:</b> <a href="solver_8h_source.html#l00061">solver.h:61</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_ab91fc238b75cc4908d380a32876551e9"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#ab91fc238b75cc4908d380a32876551e9">operations_research::math_opt::ValidateSolverParameters</a></div><div class="ttdeci">absl::Status ValidateSolverParameters(const SolveParametersProto &amp;parameters)</div><div class="ttdef"><b>Definition:</b> <a href="solver__parameters__validator_8cc_source.html#l00029">solver_parameters_validator.cc:29</a></div></div>
<div class="ttc" id="solution__validator_8h_html"><div class="ttname"><a href="solution__validator_8h.html">solution_validator.h</a></div></div>
<div class="ttc" id="classoperations__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&lt; absl::StatusOr&lt; CallbackResultProto &gt;(const CallbackDataProto &amp;)&gt; Callback</div><div class="ttdef"><b>Definition:</b> <a href="solver__interface_8h_source.html#l00055">solver_interface.h:55</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_a37e6d93b6f608edcfeb9c635c4f7b4bb"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a37e6d93b6f608edcfeb9c635c4f7b4bb">operations_research::math_opt::ValidateCallbackResultProto</a></div><div class="ttdeci">absl::Status ValidateCallbackResultProto(const CallbackResultProto &amp;callback_result, const CallbackEventProto callback_event, const CallbackRegistrationProto &amp;callback_registration, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="callback__validator_8cc_source.html#l00252">callback_validator.cc:252</a></div></div>
<div class="ttc" id="status__macros_8h_html"><div class="ttname"><a href="status__macros_8h.html">status_macros.h</a></div></div>
<div class="ttc" id="callback__validator_8h_html"><div class="ttname"><a href="callback__validator_8h.html">callback_validator.h</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_af039565f98410c47887cc13d5dbdd31b"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#af039565f98410c47887cc13d5dbdd31b">operations_research::math_opt::ValidateModel</a></div><div class="ttdeci">absl::Status ValidateModel(const ModelProto &amp;model, const bool check_names)</div><div class="ttdef"><b>Definition:</b> <a href="math__opt_2validators_2model__validator_8cc_source.html#l00251">math_opt/validators/model_validator.cc:251</a></div></div>
<div class="ttc" id="namespaceoperations__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="math__opt_2validators_2model__validator_8h_html"><div class="ttname"><a href="math__opt_2validators_2model__validator_8h.html">model_validator.h</a></div></div>
<div class="ttc" id="cp__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="status__macros_8h_html_acdc223d8c59d5c591dc6b4e88257627b"><div class="ttname"><a href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a></div><div class="ttdeci">#define RETURN_IF_ERROR(expr)</div><div class="ttdef"><b>Definition:</b> <a href="status__macros_8h_source.html#l00029">status_macros.h:29</a></div></div>
<div class="ttc" id="solver__interface_8h_html"><div class="ttname"><a href="solver__interface_8h.html">solver_interface.h</a></div></div>
<div class="ttc" id="classoperations__research_1_1_solver_html_a946780dfafc8faa3dd2d345850213be5"><div class="ttname"><a href="classoperations__research_1_1_solver.html#a946780dfafc8faa3dd2d345850213be5">operations_research::Solver::Solve</a></div><div class="ttdeci">bool Solve(DecisionBuilder *const db, const std::vector&lt; SearchMonitor * &gt; &amp;monitors)</div><div class="ttdef"><b>Definition:</b> <a href="constraint__solver_8cc_source.html#l01797">constraint_solver.cc:1797</a></div></div>
<div class="ttc" id="status__macros_8h_html_a600de4b8f65fe0a4b1898041634f9011"><div class="ttname"><a href="status__macros_8h.html#a600de4b8f65fe0a4b1898041634f9011">ASSIGN_OR_RETURN</a></div><div class="ttdeci">#define ASSIGN_OR_RETURN(lhs, rexpr)</div><div class="ttdef"><b>Definition:</b> <a href="status__macros_8h_source.html#l00055">status_macros.h:55</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_8cc.html">solver.cc</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>