Files
ortools-clone/docs/cpp/quadratic__program__io_8h_source.html
Mizux Seiha 3b81c981c2 Update doc
2022-03-04 00:19:15 +01:00

164 lines
16 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.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: quadratic_program_io.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
&#160;<span id="projectnumber">9.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('quadratic__program__io_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">quadratic_program_io.h</div></div>
</div><!--header-->
<div class="contents">
<a href="quadratic__program__io_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 &quot;License&quot;);</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 &quot;AS IS&quot; 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 PDLP_QUADRATIC_PROGRAM_IO_H_</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#define PDLP_QUADRATIC_PROGRAM_IO_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 &lt;cstdint&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &quot;absl/container/flat_hash_map.h&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include &quot;absl/status/status.h&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &quot;<a class="code" href="quadratic__program_8h.html">ortools/pdlp/quadratic_program.h</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research_1_1pdlp.html">operations_research::pdlp</a> {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">// Reads a quadratic program, determining the type based on the filename&#39;s</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">// suffix:</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment">// *.mps, *.mps.gz, *.mps.bz2 -&gt; ReadMpsLinearProgramOrDie</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">// *.pb, *.textproto, *.json, *.json.gz -&gt; ReadMPModelProtoFileOrDie</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment">// otherwise CHECK-fails.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span>QuadraticProgram <a class="code hl_function" href="namespaceoperations__research_1_1pdlp.html#adaa09ad106bba41ecd2a700b4f2aaa4d">ReadQuadraticProgramOrDie</a>(<span class="keyword">const</span> std::string&amp; filename,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">bool</span> include_names = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>QuadraticProgram <a class="code hl_function" href="namespaceoperations__research_1_1pdlp.html#af1899c94f685aeaef90aaa72c55187af">ReadMpsLinearProgramOrDie</a>(<span class="keyword">const</span> std::string&amp; lp_file,</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">bool</span> include_names = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">// The input may be MPModelProto in text format, binary format, or JSON,</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment">// possibly gzipped.</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>QuadraticProgram <a class="code hl_function" href="namespaceoperations__research_1_1pdlp.html#a8b4f8a16434fe5945c8a7e2becf5d27d">ReadMPModelProtoFileOrDie</a>(</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">const</span> std::string&amp; mpmodel_proto_file, <span class="keywordtype">bool</span> include_names = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment">// NOTE: This will fail if &#39;linear_program&#39; is actually a quadratic program</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">// (that is, has a non-empty quadratic objective term).</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>absl::Status <a class="code hl_function" href="namespaceoperations__research_1_1pdlp.html#a8673df5a703fd3d9a7a77094d6c45a4c">WriteLinearProgramToMps</a>(<span class="keyword">const</span> QuadraticProgram&amp; linear_program,</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">const</span> std::string&amp; mps_file);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>absl::Status <a class="code hl_function" href="namespaceoperations__research_1_1pdlp.html#a7928c325e6274218afc0bc74ec45d381">WriteQuadraticProgramToMPModelProto</a>(</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">const</span> QuadraticProgram&amp; quadratic_program,</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">const</span> std::string&amp; mpmodel_proto_file);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>} <span class="comment">// namespace operations_research::pdlp</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="preprocessor">#endif </span><span class="comment">// PDLP_QUADRATIC_PROGRAM_IO_H_</span></div>
<div class="ttc" id="anamespaceoperations__research_1_1pdlp_html"><div class="ttname"><a href="namespaceoperations__research_1_1pdlp.html">operations_research::pdlp</a></div><div class="ttdef"><b>Definition:</b> <a href="iteration__stats_8cc_source.html#l00040">iteration_stats.cc:40</a></div></div>
<div class="ttc" id="anamespaceoperations__research_1_1pdlp_html_a7928c325e6274218afc0bc74ec45d381"><div class="ttname"><a href="namespaceoperations__research_1_1pdlp.html#a7928c325e6274218afc0bc74ec45d381">operations_research::pdlp::WriteQuadraticProgramToMPModelProto</a></div><div class="ttdeci">absl::Status WriteQuadraticProgramToMPModelProto(const QuadraticProgram &amp;quadratic_program, const std::string &amp;mpmodel_proto_file)</div><div class="ttdef"><b>Definition:</b> <a href="quadratic__program__io_8cc_source.html#l00106">quadratic_program_io.cc:106</a></div></div>
<div class="ttc" id="anamespaceoperations__research_1_1pdlp_html_a8673df5a703fd3d9a7a77094d6c45a4c"><div class="ttname"><a href="namespaceoperations__research_1_1pdlp.html#a8673df5a703fd3d9a7a77094d6c45a4c">operations_research::pdlp::WriteLinearProgramToMps</a></div><div class="ttdeci">absl::Status WriteLinearProgramToMps(const QuadraticProgram &amp;linear_program, const std::string &amp;mps_file)</div><div class="ttdef"><b>Definition:</b> <a href="quadratic__program__io_8cc_source.html#l00091">quadratic_program_io.cc:91</a></div></div>
<div class="ttc" id="anamespaceoperations__research_1_1pdlp_html_a8b4f8a16434fe5945c8a7e2becf5d27d"><div class="ttname"><a href="namespaceoperations__research_1_1pdlp.html#a8b4f8a16434fe5945c8a7e2becf5d27d">operations_research::pdlp::ReadMPModelProtoFileOrDie</a></div><div class="ttdeci">QuadraticProgram ReadMPModelProtoFileOrDie(const std::string &amp;mpmodel_proto_file, bool include_names)</div><div class="ttdef"><b>Definition:</b> <a href="quadratic__program__io_8cc_source.html#l00081">quadratic_program_io.cc:81</a></div></div>
<div class="ttc" id="anamespaceoperations__research_1_1pdlp_html_adaa09ad106bba41ecd2a700b4f2aaa4d"><div class="ttname"><a href="namespaceoperations__research_1_1pdlp.html#adaa09ad106bba41ecd2a700b4f2aaa4d">operations_research::pdlp::ReadQuadraticProgramOrDie</a></div><div class="ttdeci">QuadraticProgram ReadQuadraticProgramOrDie(const std::string &amp;filename, bool include_names)</div><div class="ttdef"><b>Definition:</b> <a href="quadratic__program__io_8cc_source.html#l00050">quadratic_program_io.cc:50</a></div></div>
<div class="ttc" id="anamespaceoperations__research_1_1pdlp_html_af1899c94f685aeaef90aaa72c55187af"><div class="ttname"><a href="namespaceoperations__research_1_1pdlp.html#af1899c94f685aeaef90aaa72c55187af">operations_research::pdlp::ReadMpsLinearProgramOrDie</a></div><div class="ttdeci">QuadraticProgram ReadMpsLinearProgramOrDie(const std::string &amp;lp_file, bool include_names)</div><div class="ttdef"><b>Definition:</b> <a href="quadratic__program__io_8cc_source.html#l00067">quadratic_program_io.cc:67</a></div></div>
<div class="ttc" id="aquadratic__program_8h_html"><div class="ttname"><a href="quadratic__program_8h.html">quadratic_program.h</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_7cc48880791e3dd695dbfc2349101d28.html">pdlp</a></li><li class="navelem"><a class="el" href="quadratic__program__io_8h.html">quadratic_program_io.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.9.3 </li>
</ul>
</div>
</body>
</html>