169 lines
21 KiB
HTML
169 lines
21 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>OR-Tools</title>
|
|
<meta http-equiv="Content-Type" content="text/html;"/>
|
|
<meta charset="utf-8"/>
|
|
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.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="banner-container">
|
|
<div id="banner">
|
|
<span id="sfml">Google OR-Tools 9.2</span>
|
|
</div>
|
|
</div>
|
|
<div id="content" style="width: 100%; overflow: hidden;">
|
|
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
|
|
<h2>C++ Reference</h2>
|
|
<ul>
|
|
<li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
|
|
<li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
|
|
<li><a href="../cpp_graph/annotated.html">Graph</a></li>
|
|
<li><a href="../cpp_routing/annotated.html">Routing</a></li>
|
|
<li><a href="../cpp_linear/annotated.html">Linear solver</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="content">
|
|
<div align="center">
|
|
<h1 style="color: #145A32;">C++ Reference: Linear solver</h1>
|
|
</div>
|
|
<!-- Generated by Doxygen 1.9.3 -->
|
|
<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('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 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_LINEAR_SOLVER_MODEL_VALIDATOR_H_</span></div>
|
|
<div class="line"><a id="l00015" 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 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 <string></span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include "absl/types/optional.h"</span></div>
|
|
<div class="line"><a id="l00020" 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 id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include "ortools/util/lazy_mutable_copy.h"</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="l00037" name="l00037"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#aa7ee6518d30b6929f4bd0229da743f18"> 37</a></span>std::string <a class="code hl_function" href="namespaceoperations__research.html#aa7ee6518d30b6929f4bd0229da743f18">FindErrorInMPModelProto</a>(</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1_m_p_model_proto.html">MPModelProto</a>& model, <span class="keywordtype">double</span> abs_value_threshold = 0.0,</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// If false, variable and constraint bounds like [lb=1.2, ub=0.7] yield an</span></div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// error, and also integer variable bounds like [0.7, 0.8].</span></div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">bool</span> accept_trivially_infeasible_bounds = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#a2506c50d4eb5505613003f685fd1af9f"> 49</a></span>std::string <a class="code hl_function" href="namespaceoperations__research.html#a2506c50d4eb5505613003f685fd1af9f">FindErrorInMPModelDeltaProto</a>(<span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1_m_p_model_delta_proto.html">MPModelDeltaProto</a>& delta,</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1_m_p_model_proto.html">MPModelProto</a>& model);</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>absl::optional<LazyMutableCopy<MPModelProto>></div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#a97d22724a2d11191dcf78eb8e5e5064a"> 57</a></span><a class="code hl_function" href="namespaceoperations__research.html#a97d22724a2d11191dcf78eb8e5e5064a">ExtractValidMPModelOrPopulateResponseStatus</a>(<span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1_m_p_model_request.html">MPModelRequest</a>& request,</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <a class="code hl_class" href="classoperations__research_1_1_m_p_solution_response.html">MPSolutionResponse</a>* response);</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#a518848a6b3e172d127121637ab5c608d"> 65</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="namespaceoperations__research.html#a518848a6b3e172d127121637ab5c608d">ExtractValidMPModelInPlaceOrPopulateResponseStatus</a>(</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <a class="code hl_class" href="classoperations__research_1_1_m_p_model_request.html">MPModelRequest</a>* request, <a class="code hl_class" href="classoperations__research_1_1_m_p_solution_response.html">MPSolutionResponse</a>* response);</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#ae4ee4d82cf625670cdc1f52197454654"> 78</a></span>std::string <a class="code hl_function" href="namespaceoperations__research.html#ae4ee4d82cf625670cdc1f52197454654">FindFeasibilityErrorInSolutionHint</a>(<span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1_m_p_model_proto.html">MPModelProto</a>& model,</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keywordtype">double</span> tolerance);</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment">// Partially merges a MPConstraintProto onto another, skipping only the</span></div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment">// repeated fields "var_index" and "coefficients". This is used within</span></div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment">// FindErrorInMPModelDeltaProto.</span></div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment">// See the unit test MergeMPConstraintProtoExceptTermsTest that explains why we</span></div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment">// need this.</span></div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#ae6841e1b78c89cf9139fc1b9ba1ae8cb"> 86</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceoperations__research.html#ae6841e1b78c89cf9139fc1b9ba1ae8cb">MergeMPConstraintProtoExceptTerms</a>(<span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1_m_p_constraint_proto.html">MPConstraintProto</a>& from,</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <a class="code hl_class" href="classoperations__research_1_1_m_p_constraint_proto.html">MPConstraintProto</a>* to);</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment">// Applies the given model_delta to "model". Assumes that</span></div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment">// FindErrorInMPModelDeltaProto() found no error. For full error checking,</span></div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment">// please use ExtractValidMPModelOrPopulateResponseStatus() instead.</span></div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#a3ed9bad79131000a00e7f01a5f5b824c"> 92</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceoperations__research.html#a3ed9bad79131000a00e7f01a5f5b824c">ApplyVerifiedMPModelDelta</a>(<span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1_m_p_model_delta_proto.html">MPModelDeltaProto</a>& delta,</div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <a class="code hl_class" href="classoperations__research_1_1_m_p_model_proto.html">MPModelProto</a>* model);</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>} <span class="comment">// namespace operations_research</span></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><span class="preprocessor">#endif </span><span class="comment">// OR_TOOLS_LINEAR_SOLVER_MODEL_VALIDATOR_H_</span></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1_m_p_constraint_proto_html"><div class="ttname"><a href="classoperations__research_1_1_m_p_constraint_proto.html">operations_research::MPConstraintProto</a></div><div class="ttdef"><b>Definition:</b> <a href="linear__solver_8pb_8h_source.html#l00510">linear_solver.pb.h:511</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1_m_p_model_delta_proto_html"><div class="ttname"><a href="classoperations__research_1_1_m_p_model_delta_proto.html">operations_research::MPModelDeltaProto</a></div><div class="ttdef"><b>Definition:</b> <a href="linear__solver_8pb_8h_source.html#l03579">linear_solver.pb.h:3580</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1_m_p_model_proto_html"><div class="ttname"><a href="classoperations__research_1_1_m_p_model_proto.html">operations_research::MPModelProto</a></div><div class="ttdef"><b>Definition:</b> <a href="linear__solver_8pb_8h_source.html#l02800">linear_solver.pb.h:2801</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1_m_p_model_request_html"><div class="ttname"><a href="classoperations__research_1_1_m_p_model_request.html">operations_research::MPModelRequest</a></div><div class="ttdef"><b>Definition:</b> <a href="linear__solver_8pb_8h_source.html#l03789">linear_solver.pb.h:3790</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1_m_p_solution_response_html"><div class="ttname"><a href="classoperations__research_1_1_m_p_solution_response.html">operations_research::MPSolutionResponse</a></div><div class="ttdef"><b>Definition:</b> <a href="linear__solver_8pb_8h_source.html#l04478">linear_solver.pb.h:4479</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="ttdef"><b>Definition:</b> <a href="linear__expr_8h_source.html#l00084">linear_expr.h:84</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_a2506c50d4eb5505613003f685fd1af9f"><div class="ttname"><a href="namespaceoperations__research.html#a2506c50d4eb5505613003f685fd1af9f">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>
|
|
<div class="ttc" id="anamespaceoperations__research_html_a3ed9bad79131000a00e7f01a5f5b824c"><div class="ttname"><a href="namespaceoperations__research.html#a3ed9bad79131000a00e7f01a5f5b824c">operations_research::ApplyVerifiedMPModelDelta</a></div><div class="ttdeci">void ApplyVerifiedMPModelDelta(const MPModelDeltaProto &delta, MPModelProto *model)</div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_a518848a6b3e172d127121637ab5c608d"><div class="ttname"><a href="namespaceoperations__research.html#a518848a6b3e172d127121637ab5c608d">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>
|
|
<div class="ttc" id="anamespaceoperations__research_html_a97d22724a2d11191dcf78eb8e5e5064a"><div class="ttname"><a href="namespaceoperations__research.html#a97d22724a2d11191dcf78eb8e5e5064a">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>
|
|
<div class="ttc" id="anamespaceoperations__research_html_aa7ee6518d30b6929f4bd0229da743f18"><div class="ttname"><a href="namespaceoperations__research.html#aa7ee6518d30b6929f4bd0229da743f18">operations_research::FindErrorInMPModelProto</a></div><div class="ttdeci">std::string FindErrorInMPModelProto(const MPModelProto &model, double abs_value_threshold=0.0, bool accept_trivially_infeasible_bounds=false)</div><div class="ttdoc">Returns an empty string iff the model is valid and not trivially infeasible.</div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_ae4ee4d82cf625670cdc1f52197454654"><div class="ttname"><a href="namespaceoperations__research.html#ae4ee4d82cf625670cdc1f52197454654">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>
|
|
<div class="ttc" id="anamespaceoperations__research_html_ae6841e1b78c89cf9139fc1b9ba1ae8cb"><div class="ttname"><a href="namespaceoperations__research.html#ae6841e1b78c89cf9139fc1b9ba1ae8cb">operations_research::MergeMPConstraintProtoExceptTerms</a></div><div class="ttdeci">void MergeMPConstraintProtoExceptTerms(const MPConstraintProto &from, MPConstraintProto *to)</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
</div>
|
|
</div>
|
|
<div id="footer-container">
|
|
<div id="footer">
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|