Files
ortools-clone/docs/cpp_graph/iterators_8h.html
2019-06-13 15:51:12 +02:00

248 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="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&#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="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">iterators.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;iterator&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for iterators.h:</div>
<div class="dyncontent">
<div class="center"><img src="iterators_8h__incl.png" border="0" usemap="#iterators_8h" alt=""/></div>
<map name="iterators_8h" id="iterators_8h">
<area shape="rect" title=" " alt="" coords="38,5,118,31"/>
<area shape="rect" title=" " alt="" coords="5,79,68,104"/>
<area shape="rect" title=" " alt="" coords="92,79,150,104"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="iterators_8h__dep__incl.png" border="0" usemap="#iterators_8hdep" alt=""/></div>
<map name="iterators_8hdep" id="iterators_8hdep">
<area shape="rect" title=" " alt="" coords="332,5,413,31"/>
<area shape="rect" href="graph_8h.html" title=" " alt="" coords="304,79,371,104"/>
<area shape="rect" href="util_8h.html" title=" " alt="" coords="484,152,533,177"/>
<area shape="rect" href="christofides_8h.html" title=" " alt="" coords="40,152,140,177"/>
<area shape="rect" href="io_8h.html" title=" " alt="" coords="164,152,207,177"/>
<area shape="rect" href="max__flow_8h.html" title=" " alt="" coords="231,152,319,177"/>
<area shape="rect" href="min__cost__flow_8h.html" title=" " alt="" coords="344,152,460,177"/>
<area shape="rect" href="one__tree__lower__bound_8h.html" title=" " alt="" coords="5,225,174,251"/>
</map>
</div>
</div>
<p><a href="iterators_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="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMutableVectorIteration_1_1Iterator.html">MutableVectorIteration&lt; T &gt;::Iterator</a></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="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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ae7f303a443fbf651b13f8289d05ef498"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="iterators_8h.html#ae7f303a443fbf651b13f8289d05ef498">value_type</a> = typename std::iterator_traits&lt; Iterator &gt;::<a class="el" href="iterators_8h.html#ae7f303a443fbf651b13f8289d05ef498">value_type</a></td></tr>
<tr class="separator:ae7f303a443fbf651b13f8289d05ef498"><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:af3f6bc803bbe87af730cf9e41a35cf68"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="iterators_8h.html#af3f6bc803bbe87af730cf9e41a35cf68">BeginEndWrapper</a> (Iterator <a class="el" href="iterators_8h.html#a09dd208593b9721a30a83ed978ede577">begin</a>, Iterator <a class="el" href="iterators_8h.html#a62469461ed7c932afba3808f4da0fe3d">end</a>)</td></tr>
<tr class="separator:af3f6bc803bbe87af730cf9e41a35cf68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09dd208593b9721a30a83ed978ede577"><td class="memItemLeft" align="right" valign="top">Iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="iterators_8h.html#a09dd208593b9721a30a83ed978ede577">begin</a> () const</td></tr>
<tr class="separator:a09dd208593b9721a30a83ed978ede577"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62469461ed7c932afba3808f4da0fe3d"><td class="memItemLeft" align="right" valign="top">Iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="iterators_8h.html#a62469461ed7c932afba3808f4da0fe3d">end</a> () const</td></tr>
<tr class="separator:a62469461ed7c932afba3808f4da0fe3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="iterators_8h.html#a644718bb2fb240de962dc3c9a1fdf0dc">empty</a> () const</td></tr>
<tr class="separator:a644718bb2fb240de962dc3c9a1fdf0dc"><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:aadd7603ae6e78cc2490ca9710fbaf180"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutil.html#aadd7603ae6e78cc2490ca9710fbaf180">util::false</a></td></tr>
<tr class="memdesc:aadd7603ae6e78cc2490ca9710fbaf180"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is useful for wrapping iterators of a class that support many different iterations. <a href="namespaceutil.html#aadd7603ae6e78cc2490ca9710fbaf180">More...</a><br /></td></tr>
<tr class="separator:aadd7603ae6e78cc2490ca9710fbaf180"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc90f8dbcd326a450a7c781ea7a9539d"><td class="memItemLeft" align="right" valign="top">*OutgoingArcIterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutil.html#acc90f8dbcd326a450a7c781ea7a9539d">util::this</a></td></tr>
<tr class="separator:acc90f8dbcd326a450a7c781ea7a9539d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83b9f519556accd1f067da73da5f0624"><td class="memItemLeft" align="right" valign="top">**And a client will use it like&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="iterators_8h.html#a83b9f519556accd1f067da73da5f0624">this</a></td></tr>
<tr class="separator:a83b9f519556accd1f067da73da5f0624"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ae7f303a443fbf651b13f8289d05ef498"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7f303a443fbf651b13f8289d05ef498">&#9670;&nbsp;</a></span>value_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="iterators_8h.html#ae7f303a443fbf651b13f8289d05ef498">value_type</a> = typename std::iterator_traits&lt;Iterator&gt;::<a class="el" href="iterators_8h.html#ae7f303a443fbf651b13f8289d05ef498">value_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="iterators_8h_source.html#l00041">41</a> of file <a class="el" href="iterators_8h_source.html">iterators.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a09dd208593b9721a30a83ed978ede577"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09dd208593b9721a30a83ed978ede577">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Iterator begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="iterators_8h_source.html#l00044">44</a> of file <a class="el" href="iterators_8h_source.html">iterators.h</a>.</p>
</div>
</div>
<a id="af3f6bc803bbe87af730cf9e41a35cf68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3f6bc803bbe87af730cf9e41a35cf68">&#9670;&nbsp;</a></span>BeginEndWrapper()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BeginEndWrapper </td>
<td>(</td>
<td class="paramtype">Iterator&#160;</td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Iterator&#160;</td>
<td class="paramname"><em>end</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="iterators_8h_source.html#l00043">43</a> of file <a class="el" href="iterators_8h_source.html">iterators.h</a>.</p>
</div>
</div>
<a id="a644718bb2fb240de962dc3c9a1fdf0dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a644718bb2fb240de962dc3c9a1fdf0dc">&#9670;&nbsp;</a></span>empty()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool empty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="iterators_8h_source.html#l00047">47</a> of file <a class="el" href="iterators_8h_source.html">iterators.h</a>.</p>
</div>
</div>
<a id="a62469461ed7c932afba3808f4da0fe3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62469461ed7c932afba3808f4da0fe3d">&#9670;&nbsp;</a></span>end()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Iterator end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="iterators_8h_source.html#l00045">45</a> of file <a class="el" href="iterators_8h_source.html">iterators.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a83b9f519556accd1f067da73da5f0624"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83b9f519556accd1f067da73da5f0624">&#9670;&nbsp;</a></span>this</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">* * And a client will use it like this</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="iterators_8h_source.html#l00040">40</a> of file <a class="el" href="iterators_8h_source.html">iterators.h</a>.</p>
</div>
</div>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>