Files
ortools-clone/docs/cpp/model__exporter_8h_source.html
2021-09-20 15:57:27 +02:00

124 lines
19 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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: model_exporter.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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
&#160;<span id="projectnumber">9.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('model__exporter_8h_source.html','');});
/* @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_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>&#160;<span class="comment">// Copyright 2010-2021 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_EXPORTER_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_EXPORTER_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;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;absl/status/statusor.h&quot;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;absl/strings/str_format.h&quot;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="hash_8h.html">ortools/base/hash.h</a>&quot;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="macros_8h.html">ortools/base/macros.h</a>&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</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="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<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>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="structoperations__research_1_1_m_p_model_export_options.html"> 29</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structoperations__research_1_1_m_p_model_export_options.html">MPModelExportOptions</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="structoperations__research_1_1_m_p_model_export_options.html#a0e49e54db6b37b0568d9a67964bc5460"> 30</a></span>&#160; <a class="code" href="structoperations__research_1_1_m_p_model_export_options.html#a0e49e54db6b37b0568d9a67964bc5460">MPModelExportOptions</a>() {}</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structoperations__research_1_1_m_p_model_export_options.html#a838f4806313e963115cf7e9a8f7ab7e7"> 33</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structoperations__research_1_1_m_p_model_export_options.html#a838f4806313e963115cf7e9a8f7ab7e7">obfuscate</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structoperations__research_1_1_m_p_model_export_options.html#ae5002134fe40f95dc42499fc3ae35713"> 35</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structoperations__research_1_1_m_p_model_export_options.html#ae5002134fe40f95dc42499fc3ae35713">log_invalid_names</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structoperations__research_1_1_m_p_model_export_options.html#a8a260d7f9ff6c91b693a44090190c929"> 41</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structoperations__research_1_1_m_p_model_export_options.html#a8a260d7f9ff6c91b693a44090190c929">show_unused_variables</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structoperations__research_1_1_m_p_model_export_options.html#ad0a36f27591304ab29f40ca64bf24224"> 47</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structoperations__research_1_1_m_p_model_export_options.html#ad0a36f27591304ab29f40ca64bf24224">max_line_length</a> = 10000;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;};</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;absl::StatusOr&lt;std::string&gt; <a class="code" href="namespaceoperations__research.html#acc00ba1bc76286e8c84346133d407bd7">ExportModelAsLpFormat</a>(</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">const</span> <a class="code" href="classoperations__research_1_1_m_p_model_proto.html">MPModelProto</a>&amp; <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>,</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">const</span> <a class="code" href="structoperations__research_1_1_m_p_model_export_options.html">MPModelExportOptions</a>&amp; options = <a class="code" href="structoperations__research_1_1_m_p_model_export_options.html">MPModelExportOptions</a>());</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;absl::StatusOr&lt;std::string&gt; <a class="code" href="namespaceoperations__research.html#a8511ded0dd137bb52026b223ba0669b3">ExportModelAsMpsFormat</a>(</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">const</span> <a class="code" href="classoperations__research_1_1_m_p_model_proto.html">MPModelProto</a>&amp; <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>,</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keyword">const</span> <a class="code" href="structoperations__research_1_1_m_p_model_export_options.html">MPModelExportOptions</a>&amp; options = <a class="code" href="structoperations__research_1_1_m_p_model_export_options.html">MPModelExportOptions</a>());</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;} <span class="comment">// namespace operations_research</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="preprocessor">#endif // OR_TOOLS_LINEAR_SOLVER_MODEL_EXPORTER_H_</span></div><div class="ttc" id="gurobi__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#l00273">gurobi_interface.cc:273</a></div></div>
<div class="ttc" id="hash_8h_html"><div class="ttname"><a href="hash_8h.html">hash.h</a></div></div>
<div class="ttc" id="structoperations__research_1_1_m_p_model_export_options_html"><div class="ttname"><a href="structoperations__research_1_1_m_p_model_export_options.html">operations_research::MPModelExportOptions</a></div><div class="ttdoc">Export options.</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_1_m_p_model_export_options_html_ad0a36f27591304ab29f40ca64bf24224"><div class="ttname"><a href="structoperations__research_1_1_m_p_model_export_options.html#ad0a36f27591304ab29f40ca64bf24224">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#l00047">model_exporter.h:47</a></div></div>
<div class="ttc" id="macros_8h_html"><div class="ttname"><a href="macros_8h.html">macros.h</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_acc00ba1bc76286e8c84346133d407bd7"><div class="ttname"><a href="namespaceoperations__research.html#acc00ba1bc76286e8c84346133d407bd7">operations_research::ExportModelAsLpFormat</a></div><div class="ttdeci">absl::StatusOr&lt; std::string &gt; ExportModelAsLpFormat(const MPModelProto &amp;model, const MPModelExportOptions &amp;options)</div><div class="ttdoc">Outputs the current model (variables, constraints, objective) as a string encoded in the so-called &quot;C...</div><div class="ttdef"><b>Definition:</b> <a href="model__exporter_8cc_source.html#l00213">model_exporter.cc:213</a></div></div>
<div class="ttc" id="structoperations__research_1_1_m_p_model_export_options_html_a8a260d7f9ff6c91b693a44090190c929"><div class="ttname"><a href="structoperations__research_1_1_m_p_model_export_options.html#a8a260d7f9ff6c91b693a44090190c929">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#l00041">model_exporter.h:41</a></div></div>
<div class="ttc" id="structoperations__research_1_1_m_p_model_export_options_html_ae5002134fe40f95dc42499fc3ae35713"><div class="ttname"><a href="structoperations__research_1_1_m_p_model_export_options.html#ae5002134fe40f95dc42499fc3ae35713">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#l00035">model_exporter.h:35</a></div></div>
<div class="ttc" id="structoperations__research_1_1_m_p_model_export_options_html_a0e49e54db6b37b0568d9a67964bc5460"><div class="ttname"><a href="structoperations__research_1_1_m_p_model_export_options.html#a0e49e54db6b37b0568d9a67964bc5460">operations_research::MPModelExportOptions::MPModelExportOptions</a></div><div class="ttdeci">MPModelExportOptions()</div><div class="ttdef"><b>Definition:</b> <a href="model__exporter_8h_source.html#l00030">model_exporter.h:30</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">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>
<div class="ttc" id="namespaceoperations__research_html_a8511ded0dd137bb52026b223ba0669b3"><div class="ttname"><a href="namespaceoperations__research.html#a8511ded0dd137bb52026b223ba0669b3">operations_research::ExportModelAsMpsFormat</a></div><div class="ttdeci">absl::StatusOr&lt; std::string &gt; ExportModelAsMpsFormat(const MPModelProto &amp;model, const MPModelExportOptions &amp;options)</div><div class="ttdoc">Outputs the current model (variables, constraints, objective) as a string encoded in MPS file format,...</div><div class="ttdef"><b>Definition:</b> <a href="model__exporter_8cc_source.html#l00230">model_exporter.cc:230</a></div></div>
<div class="ttc" id="classoperations__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#l02723">linear_solver.pb.h:2723</a></div></div>
<div class="ttc" id="structoperations__research_1_1_m_p_model_export_options_html_a838f4806313e963115cf7e9a8f7ab7e7"><div class="ttname"><a href="structoperations__research_1_1_m_p_model_export_options.html#a838f4806313e963115cf7e9a8f7ab7e7">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#l00033">model_exporter.h:33</a></div></div>
</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_4d3a5a688e4550f3d7725aaa5ab9c27b.html">linear_solver</a></li><li class="navelem"><a class="el" href="model__exporter_8h.html">model_exporter.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.15 </li>
</ul>
</div>
</body>
</html>