Files
ortools-clone/docs/cpp_graph/io_8h.html
Laurent Perron 4536755f35 polish cpp doc
2019-07-12 13:13:30 -07:00

159 lines
13 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="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">OR-Tools 7.2</span>
</div>
</div>
<link rel="icon" href="https://developers.google.com/optimization/images/orLogo.png">
<div id="content">
<!-- Generated by Doxygen 1.8.15 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</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&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;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_725f3a5915051842f84e3ea508be2a62.html">graph</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">io.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;algorithm&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;numeric&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &quot;absl/strings/numbers.h&quot;</code><br />
<code>#include &quot;absl/strings/str_cat.h&quot;</code><br />
<code>#include &quot;absl/strings/str_format.h&quot;</code><br />
<code>#include &quot;absl/strings/str_join.h&quot;</code><br />
<code>#include &quot;absl/strings/str_split.h&quot;</code><br />
<code>#include &quot;ortools/base/filelineiter.h&quot;</code><br />
<code>#include &quot;ortools/base/statusor.h&quot;</code><br />
<code>#include &quot;<a class="el" href="graph_8h_source.html">ortools/graph/graph.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for io.h:</div>
<div class="dyncontent">
<div class="center"><img src="io_8h__incl.png" border="0" usemap="#io_8h" alt=""/></div>
<map name="io_8h" id="io_8h">
<area shape="rect" title=" " alt="" coords="2012,5,2055,32"/>
<area shape="rect" title=" " alt="" coords="5,177,80,203"/>
<area shape="rect" title=" " alt="" coords="1161,87,1231,114"/>
<area shape="rect" title=" " alt="" coords="1255,87,1323,114"/>
<area shape="rect" title=" " alt="" coords="1347,87,1402,114"/>
<area shape="rect" title=" " alt="" coords="932,259,991,285"/>
<area shape="rect" title=" " alt="" coords="1427,87,1581,114"/>
<area shape="rect" title=" " alt="" coords="1605,87,1749,114"/>
<area shape="rect" title=" " alt="" coords="1773,87,1936,114"/>
<area shape="rect" title=" " alt="" coords="1960,87,2107,114"/>
<area shape="rect" title=" " alt="" coords="2131,87,2282,114"/>
<area shape="rect" title=" " alt="" coords="2307,87,2469,114"/>
<area shape="rect" title=" " alt="" coords="2494,87,2634,114"/>
<area shape="rect" title=" " alt="" coords="2659,87,2784,114"/>
<area shape="rect" title=" " alt="" coords="2809,87,2866,114"/>
<area shape="rect" title=" " alt="" coords="105,177,165,203"/>
<area shape="rect" title=" " alt="" coords="2891,80,3016,121"/>
<area shape="rect" title=" " alt="" coords="3041,87,3223,114"/>
<area shape="rect" title=" " alt="" coords="3248,80,3373,121"/>
<area shape="rect" title=" " alt="" coords="3397,87,3576,114"/>
<area shape="rect" title=" " alt="" coords="3601,80,3738,121"/>
<area shape="rect" title=" " alt="" coords="189,169,328,211"/>
<area shape="rect" title=" " alt="" coords="999,177,1148,203"/>
<area shape="rect" title=" " alt="" coords="3763,87,3907,114"/>
<area shape="rect" title=" " alt="" coords="3931,87,4085,114"/>
<area shape="rect" href="graph_8h.html" title=" " alt="" coords="609,87,753,114"/>
<area shape="rect" title=" " alt="" coords="781,177,846,203"/>
<area shape="rect" title=" " alt="" coords="871,177,924,203"/>
<area shape="rect" title=" " alt="" coords="535,177,582,203"/>
<area shape="rect" title=" " alt="" coords="606,177,757,203"/>
<area shape="rect" href="iterators_8h.html" title=" " alt="" coords="353,177,511,203"/>
<area shape="rect" title=" " alt="" coords="401,259,463,285"/>
</map>
</div>
</div>
<p><a href="io_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceutil"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutil.html">util</a></td></tr>
<tr class="memdesc:namespaceutil"><td class="mdescLeft">&#160;</td><td class="mdescRight">Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ae705e1342dacc10a13fb3f11f91d0696"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutil.html#ae705e1342dacc10a13fb3f11f91d0696">util::GraphToStringFormat</a> { <a class="el" href="namespaceutil.html#ae705e1342dacc10a13fb3f11f91d0696acac9245da1bf36d1d9382dc579e1a4fd">util::PRINT_GRAPH_ARCS</a>,
<a class="el" href="namespaceutil.html#ae705e1342dacc10a13fb3f11f91d0696aaed5759e3b6e3a8592c9a21e0048b565">util::PRINT_GRAPH_ADJACENCY_LISTS</a>,
<a class="el" href="namespaceutil.html#ae705e1342dacc10a13fb3f11f91d0696a454bb1ede69e280a1e4959acb82748ef">util::PRINT_GRAPH_ADJACENCY_LISTS_SORTED</a>
}</td></tr>
<tr class="memdesc:ae705e1342dacc10a13fb3f11f91d0696"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a std::string representation of a graph. <a href="namespaceutil.html#ae705e1342dacc10a13fb3f11f91d0696">More...</a><br /></td></tr>
<tr class="separator:ae705e1342dacc10a13fb3f11f91d0696"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:affed79554a202aaa8bda5b5e98c3a6b2"><td class="memTemplParams" colspan="2">template&lt;class Graph &gt; </td></tr>
<tr class="memitem:affed79554a202aaa8bda5b5e98c3a6b2"><td class="memTemplItemLeft" align="right" valign="top">std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutil.html#affed79554a202aaa8bda5b5e98c3a6b2">util::GraphToString</a> (const Graph &amp;graph, GraphToStringFormat format)</td></tr>
<tr class="memdesc:affed79554a202aaa8bda5b5e98c3a6b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implementations of the templated methods. <a href="namespaceutil.html#affed79554a202aaa8bda5b5e98c3a6b2">More...</a><br /></td></tr>
<tr class="separator:affed79554a202aaa8bda5b5e98c3a6b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86199e4832dd5c1d61baa53bfecb7b6d"><td class="memItemLeft" align="right" valign="top">false&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutil.html#a86199e4832dd5c1d61baa53bfecb7b6d">util::ValueOrDie</a> ())</td></tr>
<tr class="memdesc:a86199e4832dd5c1d61baa53bfecb7b6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a graph file in the simple ".g" format: the file should be a text file containing only space-separated integers, whose first line is: &lt;num nodes&gt;=""&gt; &lt;num edges&gt;=""&gt; [&lt;num_colors&gt; &lt;index of first node with color #1&gt; &lt;index of first node with color #2&gt; ...] and whose subsequent lines represent edges if "directed" is false, or arcs if "directed" is true: &lt;node1&gt; &lt;node2&gt;. <a href="namespaceutil.html#a86199e4832dd5c1d61baa53bfecb7b6d">More...</a><br /></td></tr>
<tr class="separator:a86199e4832dd5c1d61baa53bfecb7b6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a640b5d8a0ba7deaba9afbd4f3ca438"><td class="memItemLeft" align="right" valign="top">*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutil.html#a0a640b5d8a0ba7deaba9afbd4f3ca438">util::if</a> (!error_or_graph.ok())</td></tr>
<tr class="separator:a0a640b5d8a0ba7deaba9afbd4f3ca438"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c5c6763e52cd1465a3e1a3ab2437e37"><td class="memTemplParams" colspan="2">template&lt;class Graph &gt; </td></tr>
<tr class="memitem:a9c5c6763e52cd1465a3e1a3ab2437e37"><td class="memTemplItemLeft" align="right" valign="top">***util::StatusOr&lt; Graph * &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutil.html#a9c5c6763e52cd1465a3e1a3ab2437e37">util::ReadGraphFile</a> (const std::string &amp;filename, bool directed, std::vector&lt; int &gt; *num_nodes_with_color_or_null)</td></tr>
<tr class="separator:a9c5c6763e52cd1465a3e1a3ab2437e37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6600986f328a49c9485aa03fb6c82946"><td class="memTemplParams" colspan="2">template&lt;class Graph &gt; </td></tr>
<tr class="memitem:a6600986f328a49c9485aa03fb6c82946"><td class="memTemplItemLeft" align="right" valign="top">util::Status&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutil.html#a6600986f328a49c9485aa03fb6c82946">util::WriteGraphToFile</a> (const Graph &amp;graph, const std::string &amp;filename, bool directed, const std::vector&lt; int &gt; &amp;num_nodes_with_color)</td></tr>
<tr class="memdesc:a6600986f328a49c9485aa03fb6c82946"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes a graph to the ".g" file format described above. <a href="namespaceutil.html#a6600986f328a49c9485aa03fb6c82946">More...</a><br /></td></tr>
<tr class="separator:a6600986f328a49c9485aa03fb6c82946"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeec5b66be4fd6b3021e6eb08b3045a0e"><td class="memTemplParams" colspan="2">template&lt;class Graph &gt; </td></tr>
<tr class="memitem:aeec5b66be4fd6b3021e6eb08b3045a0e"><td class="memTemplItemLeft" align="right" valign="top">util::StatusOr&lt; Graph * &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutil.html#aeec5b66be4fd6b3021e6eb08b3045a0e">util::ReadGraphFile</a> (const std::string &amp;filename, bool directed, std::vector&lt; int &gt; *num_nodes_with_color_or_null)</td></tr>
<tr class="separator:aeec5b66be4fd6b3021e6eb08b3045a0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a123e77d101e4aeb54a2b9e7d9612ad1b"><td class="memItemLeft" align="right" valign="top">***util::StatusOr&lt; MyGraph * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutil.html#a123e77d101e4aeb54a2b9e7d9612ad1b">util::error_or_graph</a></td></tr>
<tr class="memdesc:a123e77d101e4aeb54a2b9e7d9612ad1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">&lt; More complicated error handling. <a href="namespaceutil.html#a123e77d101e4aeb54a2b9e7d9612ad1b">More...</a><br /></td></tr>
<tr class="separator:a123e77d101e4aeb54a2b9e7d9612ad1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99d2b83baf3f908e76fb2161b1c73322"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutil.html#a99d2b83baf3f908e76fb2161b1c73322">util::else</a></td></tr>
<tr class="separator:a99d2b83baf3f908e76fb2161b1c73322"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>