174 lines
20 KiB
HTML
174 lines
20 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.20"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: model_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
|
|
 <span id="projectnumber">8.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.20 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('model__validator_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">model_validator.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="model__validator_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright 2010-2018 Google LLC</span></div>
|
|
<div class="line"><a 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 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 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 name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div>
|
|
<div class="line"><a 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 name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div>
|
|
<div class="line"><a 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 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 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 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 name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// limitations under the License.</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#ifndef OR_TOOLS_LINEAR_SOLVER_MODEL_VALIDATOR_H_</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define OR_TOOLS_LINEAR_SOLVER_MODEL_VALIDATOR_H_</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "absl/types/optional.h"</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="linear__solver_8pb_8h.html">ortools/linear_solver/linear_solver.pb.h</a>"</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "<a class="code" href="lazy__mutable__copy_8h.html">ortools/util/lazy_mutable_copy.h</a>"</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span><a class="code" href="namespaceoperations__research.html">operations_research</a> {</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> std::string <a class="code" href="namespaceoperations__research.html#a5b04e3765a046abeb4aed64766f494d7">FindErrorInMPModelProto</a>(<span class="keyword">const</span> MPModelProto& <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>);</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> std::string <a class="code" href="namespaceoperations__research.html#a1fe0ce1e27e08e817ec6f105976b729f">FindErrorInMPModelDeltaProto</a>(<span class="keyword">const</span> MPModelDeltaProto& <a class="code" href="resource_8cc.html#a73461c37822b6ebb75b54ba1a9ffb442">delta</a>,</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">const</span> MPModelProto& <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>);</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> absl::optional<LazyMutableCopy<MPModelProto>></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <a class="code" href="namespaceoperations__research.html#a9719cad5eece9b747a6332dd39126f0c">ExtractValidMPModelOrPopulateResponseStatus</a>(<span class="keyword">const</span> MPModelRequest& request,</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  MPSolutionResponse* <a class="code" href="cp__model__solver_8cc.html#abcd33b18ce6d5a90a4ba5c37cfa58829">response</a>);</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceoperations__research.html#a028894df65f61e94b6a406ed76901abf">ExtractValidMPModelInPlaceOrPopulateResponseStatus</a>(</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  MPModelRequest* request, MPSolutionResponse* <a class="code" href="cp__model__solver_8cc.html#abcd33b18ce6d5a90a4ba5c37cfa58829">response</a>);</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> std::string <a class="code" href="namespaceoperations__research.html#ad30505c27ac9dd7ded3396e750cbff5f">FindFeasibilityErrorInSolutionHint</a>(<span class="keyword">const</span> MPModelProto& <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>,</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">double</span> tolerance);</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// Partially merges a MPConstraintProto onto another, skipping only the</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// repeated fields "var_index" and "coefficients". This is used within</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// FindErrorInMPModelDeltaProto.</span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// See the unit test MergeMPConstraintProtoExceptTermsTest that explains why we</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">// need this.</span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keywordtype">void</span> <a class="code" href="namespaceoperations__research.html#af5d41884f3ad7b19224d25ba9bccd55a">MergeMPConstraintProtoExceptTerms</a>(<span class="keyword">const</span> MPConstraintProto& from,</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  MPConstraintProto* to);</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// PUBLIC FOR TESTING ONLY.</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// Applies the given model_delta to "model". Assumes that</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// FindErrorInMPModelDeltaProto() found no error.</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">void</span> <a class="code" href="namespaceoperations__research.html#a5fa4ae40c78d7a248efb26fde93fb805">ApplyVerifiedMPModelDelta</a>(<span class="keyword">const</span> MPModelDeltaProto& <a class="code" href="resource_8cc.html#a73461c37822b6ebb75b54ba1a9ffb442">delta</a>,</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  MPModelProto* <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>);</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> } <span class="comment">// namespace operations_research</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#endif // OR_TOOLS_LINEAR_SOLVER_MODEL_VALIDATOR_H_</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="acp__model__solver_8cc_html_abcd33b18ce6d5a90a4ba5c37cfa58829"><div class="ttname"><a href="cp__model__solver_8cc.html#abcd33b18ce6d5a90a4ba5c37cfa58829">response</a></div><div class="ttdeci">SharedResponseManager * response</div><div class="ttdef"><b>Definition:</b> <a href="cp__model__solver_8cc_source.html#l02065">cp_model_solver.cc:2065</a></div></div>
|
|
<div class="ttc" id="alinear__solver_8pb_8h_html"><div class="ttname"><a href="linear__solver_8pb_8h.html">linear_solver.pb.h</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">The vehicle routing library lets one model and solve generic vehicle routing problems ranging from th...</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="anamespaceoperations__research_html_a9719cad5eece9b747a6332dd39126f0c"><div class="ttname"><a href="namespaceoperations__research.html#a9719cad5eece9b747a6332dd39126f0c">operations_research::ExtractValidMPModelOrPopulateResponseStatus</a></div><div class="ttdeci">absl::optional< LazyMutableCopy< MPModelProto > > ExtractValidMPModelOrPopulateResponseStatus(const MPModelRequest &request, MPSolutionResponse *response)</div><div class="ttdoc">If the model is valid and non-empty, returns it (possibly after extracting the model_delta).</div><div class="ttdef"><b>Definition:</b> <a href="model__validator_8cc_source.html#l00505">model_validator.cc:505</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_a1fe0ce1e27e08e817ec6f105976b729f"><div class="ttname"><a href="namespaceoperations__research.html#a1fe0ce1e27e08e817ec6f105976b729f">operations_research::FindErrorInMPModelDeltaProto</a></div><div class="ttdeci">std::string FindErrorInMPModelDeltaProto(const MPModelDeltaProto &delta, const MPModelProto &model)</div><div class="ttdoc">Like FindErrorInMPModelProto, but for a MPModelDeltaProto applied to a given baseline model (assumed ...</div><div class="ttdef"><b>Definition:</b> <a href="model__validator_8cc_source.html#l00654">model_validator.cc:654</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_a028894df65f61e94b6a406ed76901abf"><div class="ttname"><a href="namespaceoperations__research.html#a028894df65f61e94b6a406ed76901abf">operations_research::ExtractValidMPModelInPlaceOrPopulateResponseStatus</a></div><div class="ttdeci">bool ExtractValidMPModelInPlaceOrPopulateResponseStatus(MPModelRequest *request, MPSolutionResponse *response)</div><div class="ttdoc">Like ExtractValidMPModelOrPopulateResponseStatus(), but works in-place: if the MPModel needed extract...</div><div class="ttdef"><b>Definition:</b> <a href="model__validator_8cc_source.html#l00582">model_validator.cc:582</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_ad30505c27ac9dd7ded3396e750cbff5f"><div class="ttname"><a href="namespaceoperations__research.html#ad30505c27ac9dd7ded3396e750cbff5f">operations_research::FindFeasibilityErrorInSolutionHint</a></div><div class="ttdeci">std::string FindFeasibilityErrorInSolutionHint(const MPModelProto &model, double tolerance)</div><div class="ttdoc">Returns an empty string if the solution hint given in the model is a feasible solution.</div><div class="ttdef"><b>Definition:</b> <a href="model__validator_8cc_source.html#l00595">model_validator.cc:595</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#l00195">gurobi_interface.cc:195</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_af5d41884f3ad7b19224d25ba9bccd55a"><div class="ttname"><a href="namespaceoperations__research.html#af5d41884f3ad7b19224d25ba9bccd55a">operations_research::MergeMPConstraintProtoExceptTerms</a></div><div class="ttdeci">void MergeMPConstraintProtoExceptTerms(const MPConstraintProto &from, MPConstraintProto *to)</div><div class="ttdef"><b>Definition:</b> <a href="model__validator_8cc_source.html#l00743">model_validator.cc:743</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_a5fa4ae40c78d7a248efb26fde93fb805"><div class="ttname"><a href="namespaceoperations__research.html#a5fa4ae40c78d7a248efb26fde93fb805">operations_research::ApplyVerifiedMPModelDelta</a></div><div class="ttdeci">void ApplyVerifiedMPModelDelta(const MPModelDeltaProto &delta, MPModelProto *model)</div><div class="ttdef"><b>Definition:</b> <a href="model__validator_8cc_source.html#l00786">model_validator.cc:786</a></div></div>
|
|
<div class="ttc" id="alazy__mutable__copy_8h_html"><div class="ttname"><a href="lazy__mutable__copy_8h.html">lazy_mutable_copy.h</a></div></div>
|
|
<div class="ttc" id="aresource_8cc_html_a73461c37822b6ebb75b54ba1a9ffb442"><div class="ttname"><a href="resource_8cc.html#a73461c37822b6ebb75b54ba1a9ffb442">delta</a></div><div class="ttdeci">int64 delta</div><div class="ttdef"><b>Definition:</b> <a href="resource_8cc_source.html#l01684">resource.cc:1684</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_a5b04e3765a046abeb4aed64766f494d7"><div class="ttname"><a href="namespaceoperations__research.html#a5b04e3765a046abeb4aed64766f494d7">operations_research::FindErrorInMPModelProto</a></div><div class="ttdeci">std::string FindErrorInMPModelProto(const MPModelProto &model)</div><div class="ttdoc">Returns an empty string iff the model is valid and not trivially infeasible.</div><div class="ttdef"><b>Definition:</b> <a href="model__validator_8cc_source.html#l00400">model_validator.cc:400</a></div></div>
|
|
<!-- 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_4d3a5a688e4550f3d7725aaa5ab9c27b.html">linear_solver</a></li><li class="navelem"><a class="el" href="model__validator_8h.html">model_validator.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.8.20 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|