Files
ortools-clone/docs/cpp/solution__validator_8h_source.html

178 lines
21 KiB
HTML
Raw Normal View History

2021-04-27 23:00:03 +02:00
<!-- 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"/>
2022-01-17 21:42:14 +01:00
<meta name="generator" content="Doxygen 1.9.3"/>
2021-04-27 23:00:03 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: solution_validator.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
2022-03-04 00:11:33 +01:00
&#160;<span id="projectnumber">9.3</span>
2021-04-27 23:00:03 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2022-01-17 21:42:14 +01:00
<!-- Generated by Doxygen 1.9.3 -->
2021-04-27 23:00:03 +02:00
<script type="text/javascript">
2022-01-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
2021-04-27 23:00:03 +02:00
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
2022-01-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
2021-04-27 23:00:03 +02:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2022-01-17 21:42:14 +01:00
/* @license-end */
</script>
2021-04-27 23:00:03 +02:00
<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">
2022-01-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('solution__validator_8h_source.html',''); initResizable(); });
2021-04-27 23:00:03 +02:00
/* @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">
2022-01-17 21:42:14 +01:00
<div class="headertitle"><div class="title">solution_validator.h</div></div>
2021-04-27 23:00:03 +02:00
</div><!--header-->
<div class="contents">
2022-01-17 21:42:14 +01:00
<a href="solution__validator_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2010-2021 Google LLC</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">//</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">//</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// limitations under the License.</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#ifndef OR_TOOLS_MATH_OPT_VALIDATORS_SOLUTION_VALIDATOR_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_VALIDATORS_SOLUTION_VALIDATOR_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 &quot;absl/status/status.h&quot;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><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 id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include &quot;ortools/math_opt/model_parameters.pb.h&quot;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include &quot;ortools/math_opt/solution.pb.h&quot;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &quot;ortools/math_opt/sparse_containers.pb.h&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research.html">operations_research</a> {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research_1_1math__opt.html">math_opt</a> {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>absl::Status <a class="code hl_function" href="namespaceoperations__research_1_1math__opt.html#ad538dcb289b1329d3f7c8a89cdc28119">ValidateSolution</a>(<span class="keyword">const</span> SolutionProto&amp; solution,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">const</span> ModelSolveParametersProto&amp; <a class="code hl_variable" href="cp__model__fz__solver_8cc.html#a10a1eab179b472c030bdc2a2efef7219">parameters</a>,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">const</span> ModelSummary&amp; model_summary);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>absl::Status <a class="code hl_function" href="namespaceoperations__research_1_1math__opt.html#a40a8cc2cdbe267cc55742fea9f4f3965">ValidatePrimalSolution</a>(<span class="keyword">const</span> PrimalSolutionProto&amp; primal_solution,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">const</span> SparseVectorFilterProto&amp; filter,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">const</span> ModelSummary&amp; model_summary);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment">// Used to validate callback solutions, which are represented by a</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">// SparseDoubleVectorProto and not the full PrimalSolutionProto message. Does</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment">// the same checks on a SparseDoubleVectorProto that ValidatePrimalSolution does</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">// on the variable_values sub-message of a PrimalSolutionProto.</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>absl::Status <a class="code hl_function" href="namespaceoperations__research_1_1math__opt.html#a546fae9dea58945ce0eee48764b004a0">ValidatePrimalSolutionVector</a>(<span class="keyword">const</span> SparseDoubleVectorProto&amp; vector,</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">const</span> SparseVectorFilterProto&amp; filter,</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">const</span> ModelSummary&amp; model_summary);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>absl::Status <a class="code hl_function" href="namespaceoperations__research_1_1math__opt.html#a8a82974a800783d63a0c45dad35cdaa6">ValidatePrimalRay</a>(<span class="keyword">const</span> PrimalRayProto&amp; primal_ray,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">const</span> SparseVectorFilterProto&amp; filter,</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">const</span> ModelSummary&amp; model_summary);</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>absl::Status <a class="code hl_function" href="namespaceoperations__research_1_1math__opt.html#addd56d13509da8f0f6adbf4e70688bf0">ValidateDualSolution</a>(<span class="keyword">const</span> DualSolutionProto&amp; dual_solution,</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">const</span> ModelSolveParametersProto&amp; <a class="code hl_variable" href="cp__model__fz__solver_8cc.html#a10a1eab179b472c030bdc2a2efef7219">parameters</a>,</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">const</span> ModelSummary&amp; model_summary);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>absl::Status <a class="code hl_function" href="namespaceoperations__research_1_1math__opt.html#ad37508a0980ba6157c1ea74dcbed8fce">ValidateDualRay</a>(<span class="keyword">const</span> DualRayProto&amp; dual_ray,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">const</span> ModelSolveParametersProto&amp; <a class="code hl_variable" href="cp__model__fz__solver_8cc.html#a10a1eab179b472c030bdc2a2efef7219">parameters</a>,</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">const</span> ModelSummary&amp; model_summary);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>absl::Status <a class="code hl_function" href="namespaceoperations__research_1_1math__opt.html#a18c3b71cf338f670ea077693f17cddbf">ValidateBasis</a>(<span class="keyword">const</span> BasisProto&amp; basis,</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">const</span> ModelSummary&amp; model_summary,</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">bool</span> check_dual_feasibility = <span class="keyword">true</span>);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span>} <span class="comment">// namespace math_opt</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>} <span class="comment">// namespace operations_research</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="preprocessor">#endif </span><span class="comment">// OR_TOOLS_MATH_OPT_VALIDATORS_SOLUTION_VALIDATOR_H_</span></div>
2022-03-04 00:11:33 +01:00
<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#l00119">cp_model_fz_solver.cc:119</a></div></div>
2022-01-17 21:42:14 +01:00
<div class="ttc" id="amodel__summary_8h_html"><div class="ttname"><a href="model__summary_8h.html">model_summary.h</a></div></div>
<div class="ttc" id="anamespaceoperations__research_1_1math__opt_html"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html">operations_research::math_opt</a></div><div class="ttdef"><b>Definition:</b> <a href="arrow__operator__proxy_8h_source.html#l00020">arrow_operator_proxy.h:20</a></div></div>
2022-03-04 00:11:33 +01:00
<div class="ttc" id="anamespaceoperations__research_1_1math__opt_html_a18c3b71cf338f670ea077693f17cddbf"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a18c3b71cf338f670ea077693f17cddbf">operations_research::math_opt::ValidateBasis</a></div><div class="ttdeci">absl::Status ValidateBasis(const BasisProto &amp;basis, const ModelSummary &amp;model_summary, const bool check_dual_feasibility)</div><div class="ttdef"><b>Definition:</b> <a href="solution__validator_8cc_source.html#l00242">solution_validator.cc:242</a></div></div>
<div class="ttc" id="anamespaceoperations__research_1_1math__opt_html_a40a8cc2cdbe267cc55742fea9f4f3965"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a40a8cc2cdbe267cc55742fea9f4f3965">operations_research::math_opt::ValidatePrimalSolution</a></div><div class="ttdeci">absl::Status ValidatePrimalSolution(const PrimalSolutionProto &amp;primal_solution, const SparseVectorFilterProto &amp;filter, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="solution__validator_8cc_source.html#l00168">solution_validator.cc:168</a></div></div>
<div class="ttc" id="anamespaceoperations__research_1_1math__opt_html_a546fae9dea58945ce0eee48764b004a0"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a546fae9dea58945ce0eee48764b004a0">operations_research::math_opt::ValidatePrimalSolutionVector</a></div><div class="ttdeci">absl::Status ValidatePrimalSolutionVector(const SparseDoubleVectorProto &amp;vector, const SparseVectorFilterProto &amp;filter, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="solution__validator_8cc_source.html#l00160">solution_validator.cc:160</a></div></div>
<div class="ttc" id="anamespaceoperations__research_1_1math__opt_html_a8a82974a800783d63a0c45dad35cdaa6"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a8a82974a800783d63a0c45dad35cdaa6">operations_research::math_opt::ValidatePrimalRay</a></div><div class="ttdeci">absl::Status ValidatePrimalRay(const PrimalRayProto &amp;primal_ray, const SparseVectorFilterProto &amp;filter, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="solution__validator_8cc_source.html#l00181">solution_validator.cc:181</a></div></div>
<div class="ttc" id="anamespaceoperations__research_1_1math__opt_html_ad37508a0980ba6157c1ea74dcbed8fce"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#ad37508a0980ba6157c1ea74dcbed8fce">operations_research::math_opt::ValidateDualRay</a></div><div class="ttdeci">absl::Status ValidateDualRay(const DualRayProto &amp;dual_ray, const ModelSolveParametersProto &amp;parameters, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="solution__validator_8cc_source.html#l00208">solution_validator.cc:208</a></div></div>
<div class="ttc" id="anamespaceoperations__research_1_1math__opt_html_ad538dcb289b1329d3f7c8a89cdc28119"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#ad538dcb289b1329d3f7c8a89cdc28119">operations_research::math_opt::ValidateSolution</a></div><div class="ttdeci">absl::Status ValidateSolution(const SolutionProto &amp;solution, const ModelSolveParametersProto &amp;parameters, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="solution__validator_8cc_source.html#l00116">solution_validator.cc:116</a></div></div>
<div class="ttc" id="anamespaceoperations__research_1_1math__opt_html_addd56d13509da8f0f6adbf4e70688bf0"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#addd56d13509da8f0f6adbf4e70688bf0">operations_research::math_opt::ValidateDualSolution</a></div><div class="ttdeci">absl::Status ValidateDualSolution(const DualSolutionProto &amp;dual_solution, const ModelSolveParametersProto &amp;parameters, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="solution__validator_8cc_source.html#l00190">solution_validator.cc:190</a></div></div>
2022-01-17 21:42:14 +01:00
<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>
2021-04-27 23:00:03 +02:00
</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_2298c6cf5b60fbeba088c3582d3d0ae0.html">validators</a></li><li class="navelem"><a class="el" href="solution__validator_8h.html">solution_validator.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
2022-01-17 21:42:14 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.3 </li>
2021-04-27 23:00:03 +02:00
</ul>
</div>
</body>
</html>