Skip to content

Q
qgroundcontrol
Switch branch/tag
Find file
Normal viewHistoryPermalink
model__validator_8h_source.html 15.7 KB
Newer Older
Valentin Platzgummer's avatar
or-tools src added
b443244f
 
Valentin Platzgummer committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 
<!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"/>-->
        <link rel="stylesheet" type="text/css" href="ortools.css" title="default" media="screen,print" />
        <script type="text/javascript" src="jquery.js"></script>
        <script type="text/javascript" src="dynsections.js"></script>
    </head>
    <body>
        <div id="banner-container">
            <div id="banner">
                <span id="sfml">Google OR-Tools 7.7</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.8.18 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <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>  </ul>
</div>
</div><!-- top -->
<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>&#160;<span class="comment">// Copyright 2010-2018 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">#ifndef OR_TOOLS_LINEAR_SOLVER_MODEL_VALIDATOR_H_</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<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>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &quot;absl/types/optional.h&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="linear__solver_8pb_8h.html">ortools/linear_solver/linear_solver.pb.h</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &quot;ortools/util/lazy_mutable_copy.h&quot;</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="keyword">namespace </span><a class="code" href="namespaceoperations__research.html">operations_research</a> {</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#a7a27bb74d09b7ba6ea0e97bb572d2755">   33</a></span>&#160;std::string <a class="code" href="namespaceoperations__research.html#a7a27bb74d09b7ba6ea0e97bb572d2755">FindErrorInMPModelProto</a>(<span class="keyword">const</span> MPModelProto&amp; model);</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#a2506c50d4eb5505613003f685fd1af9f">   41</a></span>&#160;std::string <a class="code" href="namespaceoperations__research.html#a2506c50d4eb5505613003f685fd1af9f">FindErrorInMPModelDeltaProto</a>(<span class="keyword">const</span> MPModelDeltaProto&amp; delta,</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;                                         <span class="keyword">const</span> MPModelProto&amp; model);</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;absl::optional&lt;LazyMutableCopy&lt;MPModelProto&gt;&gt;</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#a9ea9cebfb356f7781724405eea08e7f4">   49</a></span>&#160;<a class="code" href="namespaceoperations__research.html#a9ea9cebfb356f7781724405eea08e7f4">ExtractValidMPModelOrPopulateResponseStatus</a>(<span class="keyword">const</span> MPModelRequest&amp; request,</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;                                            MPSolutionResponse* response);</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#a518848a6b3e172d127121637ab5c608d">   57</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="namespaceoperations__research.html#a518848a6b3e172d127121637ab5c608d">ExtractValidMPModelInPlaceOrPopulateResponseStatus</a>(</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    MPModelRequest* request, MPSolutionResponse* response);</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#ae4ee4d82cf625670cdc1f52197454654">   70</a></span>&#160;std::string <a class="code" href="namespaceoperations__research.html#ae4ee4d82cf625670cdc1f52197454654">FindFeasibilityErrorInSolutionHint</a>(<span class="keyword">const</span> MPModelProto&amp; model,</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;                                               <span class="keywordtype">double</span> tolerance);</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<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>&#160;<span class="comment">// repeated fields &quot;var_index&quot; and &quot;coefficients&quot;. This is used within</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment">// FindErrorInMPModelDeltaProto.</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<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>&#160;<span class="comment">// need this.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#ae6841e1b78c89cf9139fc1b9ba1ae8cb">   78</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="namespaceoperations__research.html#ae6841e1b78c89cf9139fc1b9ba1ae8cb">MergeMPConstraintProtoExceptTerms</a>(<span class="keyword">const</span> MPConstraintProto&amp; from,</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;                                       MPConstraintProto* to);</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;<span class="comment">// PUBLIC FOR TESTING ONLY.</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment">// Applies the given model_delta to &quot;model&quot;. Assumes that</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment">// FindErrorInMPModelDeltaProto() found no error.</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#a3ed9bad79131000a00e7f01a5f5b824c">   84</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="namespaceoperations__research.html#a3ed9bad79131000a00e7f01a5f5b824c">ApplyVerifiedMPModelDelta</a>(<span class="keyword">const</span> MPModelDeltaProto&amp; delta,</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;                               MPModelProto* model);</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;}  <span class="comment">// namespace operations_research</span></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="preprocessor">#endif  // OR_TOOLS_LINEAR_SOLVER_MODEL_VALIDATOR_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespaceoperations__research_html_a9ea9cebfb356f7781724405eea08e7f4"><div class="ttname"><a href="namespaceoperations__research.html#a9ea9cebfb356f7781724405eea08e7f4">operations_research::ExtractValidMPModelOrPopulateResponseStatus</a></div><div class="ttdeci">absl::optional&lt; LazyMutableCopy&lt; MPModelProto &gt; &gt; ExtractValidMPModelOrPopulateResponseStatus(const MPModelRequest &amp;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_a2506c50d4eb5505613003f685fd1af9f"><div class="ttname"><a href="namespaceoperations__research.html#a2506c50d4eb5505613003f685fd1af9f">operations_research::FindErrorInMPModelDeltaProto</a></div><div class="ttdeci">std::string FindErrorInMPModelDeltaProto(const MPModelDeltaProto &amp;delta, const MPModelProto &amp;model)</div><div class="ttdoc">Like FindErrorInMPModelProto, but for a MPModelDeltaProto applied to a given baseline model (assumed ...</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_ae6841e1b78c89cf9139fc1b9ba1ae8cb"><div class="ttname"><a href="namespaceoperations__research.html#ae6841e1b78c89cf9139fc1b9ba1ae8cb">operations_research::MergeMPConstraintProtoExceptTerms</a></div><div class="ttdeci">void MergeMPConstraintProtoExceptTerms(const MPConstraintProto &amp;from, MPConstraintProto *to)</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_a3ed9bad79131000a00e7f01a5f5b824c"><div class="ttname"><a href="namespaceoperations__research.html#a3ed9bad79131000a00e7f01a5f5b824c">operations_research::ApplyVerifiedMPModelDelta</a></div><div class="ttdeci">void ApplyVerifiedMPModelDelta(const MPModelDeltaProto &amp;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_a7a27bb74d09b7ba6ea0e97bb572d2755"><div class="ttname"><a href="namespaceoperations__research.html#a7a27bb74d09b7ba6ea0e97bb572d2755">operations_research::FindErrorInMPModelProto</a></div><div class="ttdeci">std::string FindErrorInMPModelProto(const MPModelProto &amp;model)</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 &amp;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>
        </div>
        <div id="footer-container">
            <div id="footer">
            </div>
        </div>
    </body>
</html>