63 lines
23 KiB
HTML
63 lines
23 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"/>-->
|
|
<link rel="stylesheet" type="text/css" href="doxygen.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">OR-Tools 7.1@</span>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<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="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</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_exporter.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="model__exporter_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_EXPORTER_H_</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define OR_TOOLS_LINEAR_SOLVER_MODEL_EXPORTER_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> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "absl/strings/str_format.h"</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "ortools/base/hash.h"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "ortools/base/macros.h"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "ortools/base/statusor.h"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</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="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html"> 26</a></span> <span class="keyword">namespace </span><a class="code" href="namespaceoperations__research.html">operations_research</a> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structoperations__research_1_1MPModelExportOptions.html"> 28</a></span> <span class="keyword">struct </span><a class="code" href="structoperations__research_1_1MPModelExportOptions.html">MPModelExportOptions</a> {</div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="structoperations__research_1_1MPModelExportOptions.html#a86112c3c11136b95424b6c60627d91b1"> 29</a></span>  <a class="code" href="structoperations__research_1_1MPModelExportOptions.html#a86112c3c11136b95424b6c60627d91b1">MPModelExportOptions</a>() {}</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">// Obfuscates variable and constraint names.</span></div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structoperations__research_1_1MPModelExportOptions.html#af22a80b78769d34299cdc7c39549bb3b"> 32</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structoperations__research_1_1MPModelExportOptions.html#af22a80b78769d34299cdc7c39549bb3b">obfuscate</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// Whether to log invalid variable and constraint names.</span></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structoperations__research_1_1MPModelExportOptions.html#a7b8fcb7a9d972c70ccb83d34bfd9e207"> 34</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structoperations__research_1_1MPModelExportOptions.html#a7b8fcb7a9d972c70ccb83d34bfd9e207">log_invalid_names</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment">// For .lp files only. Decides whether variables unused in the objective and</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// constraints are shown when exported to a file.</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structoperations__research_1_1MPModelExportOptions.html#a5e95cfdaa41bc1970763fbb1910286ac"> 38</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structoperations__research_1_1MPModelExportOptions.html#a5e95cfdaa41bc1970763fbb1910286ac">show_unused_variables</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="comment">// For .lp files only. Maximum line length in exported files. The default</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// was chosen so that SCIP can read the files.</span></div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structoperations__research_1_1MPModelExportOptions.html#af2188b57edde3fa11b664af741cd4d18"> 41</a></span>  <span class="keywordtype">int</span> <a class="code" href="structoperations__research_1_1MPModelExportOptions.html#af2188b57edde3fa11b664af741cd4d18">max_line_length</a> = 10000;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> };</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// Outputs the current model (variables, constraints, objective) as a</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// std::string encoded in the so-called "CPLEX LP file format" as generated by</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// SCIP. The LP file format is easily readable by a human.</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">//</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// Returns false if some error has occurred during execution.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// The validity of names is automatically checked. If a variable name or a</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// constraint name is invalid or non-existent, a new valid name is</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// automatically generated.</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">//</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// If 'obfuscated' is true, the variable and constraint names of proto_</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// are not used. Variable and constraint names of the form "V12345"</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// and "C12345" are used instead.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">//</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">// For more information about the different LP file formats:</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// http://lpsolve.sourceforge.net/5.5/lp-format.htm</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// The following give a reasonable idea of the CPLEX LP file format:</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// http://lpsolve.sourceforge.net/5.5/CPLEX-format.htm</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// http://tinyurl.com/cplex-lp-format</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// http://www.gurobi.com/documentation/5.1/reference-manual/node871</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> util::StatusOr<std::string> <a class="code" href="namespaceoperations__research.html#a689d3552f87e89456c0c9a43847c964a">ExportModelAsLpFormat</a>(</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">const</span> <a class="code" href="classoperations__research_1_1MPModelProto.html">MPModelProto</a>& model,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">const</span> <a class="code" href="structoperations__research_1_1MPModelExportOptions.html">MPModelExportOptions</a>& options = <a class="code" href="structoperations__research_1_1MPModelExportOptions.html">MPModelExportOptions</a>());</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// Outputs the current model (variables, constraints, objective) as a</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// std::string encoded in MPS file format, using the "free" MPS format.</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">//</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// Returns false if some error has occurred during execution. Models with</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// maximization objectives trigger an error, because MPS can encode only</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">// minimization problems.</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">//</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// The validity of names is automatically checked. If a variable name or a</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// constraint name is invalid or non-existent, a new valid name is</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// automatically generated.</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">//</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">// Name validity and obfuscation works exactly as in ExportModelAsLpFormat().</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">//</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">// For more information about the MPS format:</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// http://en.wikipedia.org/wiki/MPS_(format)</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// A close-to-original description coming from OSL:</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// http://tinyurl.com/mps-format-by-osl</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">// A recent description from CPLEX:</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// http://tinyurl.com/mps-format-by-cplex</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">// CPLEX extensions:</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// http://tinyurl.com/mps-extensions-by-cplex</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// Gurobi's description:</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// http://www.gurobi.com/documentation/5.1/reference-manual/node869</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> util::StatusOr<std::string> <a class="code" href="namespaceoperations__research.html#aef684073daca7460490db8d881f886e0">ExportModelAsMpsFormat</a>(</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">const</span> <a class="code" href="classoperations__research_1_1MPModelProto.html">MPModelProto</a>& model,</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">const</span> <a class="code" href="structoperations__research_1_1MPModelExportOptions.html">MPModelExportOptions</a>& options = <a class="code" href="structoperations__research_1_1MPModelExportOptions.html">MPModelExportOptions</a>());</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> } <span class="comment">// namespace operations_research</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#endif // OR_TOOLS_LINEAR_SOLVER_MODEL_EXPORTER_H_</span></div><div class="ttc" id="structoperations__research_1_1MPModelExportOptions_html"><div class="ttname"><a href="structoperations__research_1_1MPModelExportOptions.html">operations_research::MPModelExportOptions</a></div><div class="ttdef"><b>Definition:</b> <a href="model__exporter_8h_source.html#l00028">model_exporter.h:28</a></div></div>
|
|
<div class="ttc" id="structoperations__research_1_1MPModelExportOptions_html_a86112c3c11136b95424b6c60627d91b1"><div class="ttname"><a href="structoperations__research_1_1MPModelExportOptions.html#a86112c3c11136b95424b6c60627d91b1">operations_research::MPModelExportOptions::MPModelExportOptions</a></div><div class="ttdeci">MPModelExportOptions()</div><div class="ttdef"><b>Definition:</b> <a href="model__exporter_8h_source.html#l00029">model_exporter.h:29</a></div></div>
|
|
<div class="ttc" id="structoperations__research_1_1MPModelExportOptions_html_a7b8fcb7a9d972c70ccb83d34bfd9e207"><div class="ttname"><a href="structoperations__research_1_1MPModelExportOptions.html#a7b8fcb7a9d972c70ccb83d34bfd9e207">operations_research::MPModelExportOptions::log_invalid_names</a></div><div class="ttdeci">bool log_invalid_names</div><div class="ttdoc">Whether to log invalid variable and constraint names.</div><div class="ttdef"><b>Definition:</b> <a href="model__exporter_8h_source.html#l00034">model_exporter.h:34</a></div></div>
|
|
<div class="ttc" id="structoperations__research_1_1MPModelExportOptions_html_a5e95cfdaa41bc1970763fbb1910286ac"><div class="ttname"><a href="structoperations__research_1_1MPModelExportOptions.html#a5e95cfdaa41bc1970763fbb1910286ac">operations_research::MPModelExportOptions::show_unused_variables</a></div><div class="ttdeci">bool show_unused_variables</div><div class="ttdoc">For .lp files only.</div><div class="ttdef"><b>Definition:</b> <a href="model__exporter_8h_source.html#l00038">model_exporter.h:38</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_html_aef684073daca7460490db8d881f886e0"><div class="ttname"><a href="namespaceoperations__research.html#aef684073daca7460490db8d881f886e0">operations_research::ExportModelAsMpsFormat</a></div><div class="ttdeci">util::StatusOr< std::string > ExportModelAsMpsFormat(const MPModelProto &model, const MPModelExportOptions &options=MPModelExportOptions())</div><div class="ttdoc">Outputs the current model (variables, constraints, objective) as a std::string encoded in MPS file fo...</div></div>
|
|
<div class="ttc" id="structoperations__research_1_1MPModelExportOptions_html_af2188b57edde3fa11b664af741cd4d18"><div class="ttname"><a href="structoperations__research_1_1MPModelExportOptions.html#af2188b57edde3fa11b664af741cd4d18">operations_research::MPModelExportOptions::max_line_length</a></div><div class="ttdeci">int max_line_length</div><div class="ttdoc">For .lp files only.</div><div class="ttdef"><b>Definition:</b> <a href="model__exporter_8h_source.html#l00041">model_exporter.h:41</a></div></div>
|
|
<div class="ttc" id="linear__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="namespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdoc">Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in c...</div><div class="ttdef"><b>Definition:</b> <a href="model__exporter_8h_source.html#l00026">model_exporter.h:26</a></div></div>
|
|
<div class="ttc" id="classoperations__research_1_1MPModelProto_html"><div class="ttname"><a href="classoperations__research_1_1MPModelProto.html">operations_research::MPModelProto</a></div><div class="ttdef"><b>Definition:</b> <a href="linear__solver_8pb_8h_source.html#l00966">linear_solver.pb.h:966</a></div></div>
|
|
<div class="ttc" id="structoperations__research_1_1MPModelExportOptions_html_af22a80b78769d34299cdc7c39549bb3b"><div class="ttname"><a href="structoperations__research_1_1MPModelExportOptions.html#af22a80b78769d34299cdc7c39549bb3b">operations_research::MPModelExportOptions::obfuscate</a></div><div class="ttdeci">bool obfuscate</div><div class="ttdoc">Obfuscates variable and constraint names.</div><div class="ttdef"><b>Definition:</b> <a href="model__exporter_8h_source.html#l00032">model_exporter.h:32</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_html_a689d3552f87e89456c0c9a43847c964a"><div class="ttname"><a href="namespaceoperations__research.html#a689d3552f87e89456c0c9a43847c964a">operations_research::ExportModelAsLpFormat</a></div><div class="ttdeci">util::StatusOr< std::string > ExportModelAsLpFormat(const MPModelProto &model, const MPModelExportOptions &options=MPModelExportOptions())</div><div class="ttdoc">Outputs the current model (variables, constraints, objective) as a std::string encoded in the so-call...</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div>
|
|
<div id="footer-container">
|
|
<div id="footer">
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|