docs/html/class_sylph_1_1_sylph_iterator.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>LibSylph: Sylph::SylphIterator&lt; Iter &gt; Class Template Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.5.8 -->
   7 <div class="navigation" id="top">
   8   <div class="tabs">
   9     <ul>
  10       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  11       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  12       <li class="current"><a href="classes.html"><span>Classes</span></a></li>
  13       <li><a href="files.html"><span>Files</span></a></li>
  14       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  15     </ul>
  16   </div>
  17   <div class="tabs">
  18     <ul>
  19       <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
  20       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  21       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  22     </ul>
  23   </div>
  24   <div class="navpath"><a class="el" href="namespace_sylph.html">Sylph</a>::<a class="el" href="class_sylph_1_1_sylph_iterator.html">SylphIterator</a>
  25   </div>
  26 </div>
  27 <div class="contents">
  28 <h1>Sylph::SylphIterator&lt; Iter &gt; Class Template Reference</h1><!-- doxytag: class="Sylph::SylphIterator" --><!-- doxytag: inherits="Sylph::Object" --><a class="el" href="class_sylph_1_1_sylph_iterator.html" title="SylphIterator provides a easier-to-use wrapper around STL iterators.">SylphIterator</a> provides a easier-to-use wrapper around STL iterators.
  29 <a href="#_details">More...</a>
  30 <p>
  31 <code>#include &lt;<a class="el" href="_iterator_8h-source.html">Sylph/Core/Iterator.h</a>&gt;</code>
  32 <p>
  33 <div class="dynheader">
  34 Inheritance diagram for Sylph::SylphIterator&lt; Iter &gt;:</div>
  35 <div class="dynsection">
  36 <p><center><img src="class_sylph_1_1_sylph_iterator__inherit__graph.png" border="0" usemap="#_sylph_1_1_sylph_iterator_3_01_iter_01_4__inherit__map" alt="Inheritance graph"></center>
  37 <map name="_sylph_1_1_sylph_iterator_3_01_iter_01_4__inherit__map">
  38 <area shape="rect" id="node2" href="class_sylph_1_1_object.html" title="The root of all classes." alt="" coords="53,5,165,35"></map>
  39 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
  40
  41 <p>
  42 <a href="class_sylph_1_1_sylph_iterator-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  43 <tr><td></td></tr>
  44 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  45 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#6f74149cc4a6e7a057f51c33ce26709b">SylphIterator</a> (Iter &amp;it)</td></tr>
  46
  47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new Iterator from an STL-iterator.  <a href="#6f74149cc4a6e7a057f51c33ce26709b"></a><br></td></tr>
  48 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#550c350d2d7744a7fd6af44c716fb846">~SylphIterator</a> ()</td></tr>
  49
  50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#550c350d2d7744a7fd6af44c716fb846"></a><br></td></tr>
  51 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#24c0cef4d514f69fec6577f55dc93799">hasNext</a> () const </td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks if this iterator has any more entries in forward direction.  <a href="#24c0cef4d514f69fec6577f55dc93799"></a><br></td></tr>
  54 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const Iter::reference&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#5cafc479cfa2742212ed80b4e1b03a4e">next</a> () const </td></tr>
  55
  56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the next entry in the forward direction and moves the iterator one place forward.  <a href="#5cafc479cfa2742212ed80b4e1b03a4e"></a><br></td></tr>
  57 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#42de0477358aa16970ef257d041047e3">hasPrevious</a> () const </td></tr>
  58
  59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks if this iterator has any more entries in backward direction.  <a href="#42de0477358aa16970ef257d041047e3"></a><br></td></tr>
  60 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const Iter::reference&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#3277c644458465f50deb6713d308309c">previous</a> () const </td></tr>
  61
  62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the next entry in the backward direction and moves the iterator one place backward.  <a href="#3277c644458465f50deb6713d308309c"></a><br></td></tr>
  63 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#da51b20d4f61fb1728e19100d6da0ba2">front</a> () const </td></tr>
  64
  65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves the Iterator to the place "before" the first item, that is, it gives the pointer in the iterator such a value that hasPrevious returns false.  <a href="#da51b20d4f61fb1728e19100d6da0ba2"></a><br></td></tr>
  66 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#70994ef8bc524a231b6852f3ce05b94b">back</a> () const </td></tr>
  67
  68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves the Iterator to the place "after" the last item, that is, it gives the pointer in the iterator such a value that hasNext returns false.  <a href="#70994ef8bc524a231b6852f3ce05b94b"></a><br></td></tr>
  69 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::idx_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#fe653e20cc020e9fea58b2e0b8be8ab9">nextIndex</a> () const </td></tr>
  70
  71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the next index of the Iterable in the forward direction.  <a href="#fe653e20cc020e9fea58b2e0b8be8ab9"></a><br></td></tr>
  72 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::idx_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#9966f87c9c01a9a13523a34568989124">previousIndex</a> () const </td></tr>
  73
  74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the next index of the Iterable in the backward direction.  <a href="#9966f87c9c01a9a13523a34568989124"></a><br></td></tr>
  75 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#dea685b03c30249496bdd82f303323d5">set</a> (typename Iter::reference t)</td></tr>
  76
  77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Replaces the last item returned by <a class="el" href="class_sylph_1_1_sylph_iterator.html#5cafc479cfa2742212ed80b4e1b03a4e" title="Returns the next entry in the forward direction and moves the iterator one place...">next()</a> or <a class="el" href="class_sylph_1_1_sylph_iterator.html#3277c644458465f50deb6713d308309c" title="Returns the next entry in the backward direction and moves the iterator one place...">previous()</a> with the given item.  <a href="#dea685b03c30249496bdd82f303323d5"></a><br></td></tr>
  78 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2f46f4a09608eb6d53e4148f23805b6f"></a><!-- doxytag: member="Sylph::SylphIterator::operator++" ref="2f46f4a09608eb6d53e4148f23805b6f" args="() const " -->
  79 const Iter::reference&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#2f46f4a09608eb6d53e4148f23805b6f">operator++</a> () const </td></tr>
  80
  81 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Synonymous for <a class="el" href="class_sylph_1_1_sylph_iterator.html#5cafc479cfa2742212ed80b4e1b03a4e" title="Returns the next entry in the forward direction and moves the iterator one place...">next()</a>. <br></td></tr>
  82 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62ec59cb349ca1e92fbcbe75176d5c4f"></a><!-- doxytag: member="Sylph::SylphIterator::operator&#45;&#45;" ref="62ec59cb349ca1e92fbcbe75176d5c4f" args="() const " -->
  83 const Iter::reference&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#62ec59cb349ca1e92fbcbe75176d5c4f">operator--</a> () const </td></tr>
  84
  85 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Synonymous for <a class="el" href="class_sylph_1_1_sylph_iterator.html#3277c644458465f50deb6713d308309c" title="Returns the next entry in the backward direction and moves the iterator one place...">previous()</a>. <br></td></tr>
  86 <tr><td class="memItemLeft" nowrap align="right" valign="top">const Iter::reference&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#3ea8e165a6e4438fcb82f86117f0b16d">operator++</a> (int) const </td></tr>
  87
  88 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Synoynmous for <a class="el" href="class_sylph_1_1_sylph_iterator.html#5cafc479cfa2742212ed80b4e1b03a4e" title="Returns the next entry in the forward direction and moves the iterator one place...">next()</a>.  <a href="#3ea8e165a6e4438fcb82f86117f0b16d"></a><br></td></tr>
  89 <tr><td class="memItemLeft" nowrap align="right" valign="top">const Iter::reference&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_sylph_iterator.html#40260b5a6935ec8b2403680e34e9e91f">operator--</a> (int) const </td></tr>
  90
  91 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Synonymous for <a class="el" href="class_sylph_1_1_sylph_iterator.html#3277c644458465f50deb6713d308309c" title="Returns the next entry in the backward direction and moves the iterator one place...">previous()</a>.  <a href="#40260b5a6935ec8b2403680e34e9e91f"></a><br></td></tr>
  92 </table>
  93 <hr><a name="_details"></a><h2>Detailed Description</h2>
  94 <h3>template&lt;class Iter&gt;<br>
  95  class Sylph::SylphIterator&lt; Iter &gt;</h3>
  96
  97 <a class="el" href="class_sylph_1_1_sylph_iterator.html" title="SylphIterator provides a easier-to-use wrapper around STL iterators.">SylphIterator</a> provides a easier-to-use wrapper around STL iterators.
  98 <p>
  99 The interface of a <a class="el" href="class_sylph_1_1_sylph_iterator.html" title="SylphIterator provides a easier-to-use wrapper around STL iterators.">SylphIterator</a> is similar to a Java-style iterator, but it is backed by a STL iterator and can therefore be used for any class supporitng STL iterators. <hr><h2>Constructor &amp; Destructor Documentation</h2>
 100 <a class="anchor" name="6f74149cc4a6e7a057f51c33ce26709b"></a><!-- doxytag: member="Sylph::SylphIterator::SylphIterator" ref="6f74149cc4a6e7a057f51c33ce26709b" args="(Iter &amp;it)" -->
 101 <div class="memitem">
 102 <div class="memproto">
 103 <div class="memtemplate">
 104 template&lt;class Iter &gt; </div>
 105       <table class="memname">
 106         <tr>
 107           <td class="memname"><a class="el" href="class_sylph_1_1_sylph_iterator.html">Sylph::SylphIterator</a>&lt; Iter &gt;::<a class="el" href="class_sylph_1_1_sylph_iterator.html">SylphIterator</a>           </td>
 108           <td>(</td>
 109           <td class="paramtype">Iter &amp;&nbsp;</td>
 110           <td class="paramname"> <em>it</em>          </td>
 111           <td>&nbsp;)&nbsp;</td>
 112           <td><code> [inline]</code></td>
 113         </tr>
 114       </table>
 115 </div>
 116 <div class="memdoc">
 117
 118 <p>
 119 Creates a new Iterator from an STL-iterator.
 120 <p>
 121 An Iterator can either be constructed explicitly with this constructor, in which case the correct type of Iterator for the particular collection needs to be known, or through Iterable::iterator() or Iterable::mutableIterator() . <dl compact><dt><b>Parameters:</b></dt><dd>
 122   <table border="0" cellspacing="2" cellpadding="0">
 123     <tr><td valign="top"></td><td valign="top"><em>it</em>&nbsp;</td><td>The iterable to iterate over. </td></tr>
 124   </table>
 125 </dl>
 126
 127 </div>
 128 </div><p>
 129 <a class="anchor" name="550c350d2d7744a7fd6af44c716fb846"></a><!-- doxytag: member="Sylph::SylphIterator::~SylphIterator" ref="550c350d2d7744a7fd6af44c716fb846" args="()" -->
 130 <div class="memitem">
 131 <div class="memproto">
 132 <div class="memtemplate">
 133 template&lt;class Iter &gt; </div>
 134       <table class="memname">
 135         <tr>
 136           <td class="memname">virtual <a class="el" href="class_sylph_1_1_sylph_iterator.html">Sylph::SylphIterator</a>&lt; Iter &gt;::~<a class="el" href="class_sylph_1_1_sylph_iterator.html">SylphIterator</a>           </td>
 137           <td>(</td>
 138           <td class="paramname">          </td>
 139           <td>&nbsp;)&nbsp;</td>
 140           <td><code> [inline, virtual]</code></td>
 141         </tr>
 142       </table>
 143 </div>
 144 <div class="memdoc">
 145
 146 <p>
 147 Destructor.
 148 <p>
 149 This destructor does nothing.
 150 </div>
 151 </div><p>
 152 <hr><h2>Member Function Documentation</h2>
 153 <a class="anchor" name="70994ef8bc524a231b6852f3ce05b94b"></a><!-- doxytag: member="Sylph::SylphIterator::back" ref="70994ef8bc524a231b6852f3ce05b94b" args="() const " -->
 154 <div class="memitem">
 155 <div class="memproto">
 156 <div class="memtemplate">
 157 template&lt;class Iter &gt; </div>
 158       <table class="memname">
 159         <tr>
 160           <td class="memname">virtual void <a class="el" href="class_sylph_1_1_sylph_iterator.html">Sylph::SylphIterator</a>&lt; Iter &gt;::back           </td>
 161           <td>(</td>
 162           <td class="paramname">          </td>
 163           <td>&nbsp;)&nbsp;</td>
 164           <td> const<code> [inline, virtual]</code></td>
 165         </tr>
 166       </table>
 167 </div>
 168 <div class="memdoc">
 169
 170 <p>
 171 Moves the Iterator to the place "after" the last item, that is, it gives the pointer in the iterator such a value that hasNext returns false.
 172 <p>
 173 This method is useful for backward iterating, i.e. <pre>Iterator it = coll.getIterator(); // normal 'forward' iterator
 174  it.back(); // ready for backward iteration </pre>
 175 </div>
 176 </div><p>
 177 <a class="anchor" name="da51b20d4f61fb1728e19100d6da0ba2"></a><!-- doxytag: member="Sylph::SylphIterator::front" ref="da51b20d4f61fb1728e19100d6da0ba2" args="() const " -->
 178 <div class="memitem">
 179 <div class="memproto">
 180 <div class="memtemplate">
 181 template&lt;class Iter &gt; </div>
 182       <table class="memname">
 183         <tr>
 184           <td class="memname">virtual void <a class="el" href="class_sylph_1_1_sylph_iterator.html">Sylph::SylphIterator</a>&lt; Iter &gt;::front           </td>
 185           <td>(</td>
 186           <td class="paramname">          </td>
 187           <td>&nbsp;)&nbsp;</td>
 188           <td> const<code> [inline, virtual]</code></td>
 189         </tr>
 190       </table>
 191 </div>
 192 <div class="memdoc">
 193
 194 <p>
 195 Moves the Iterator to the place "before" the first item, that is, it gives the pointer in the iterator such a value that hasPrevious returns false.
 196 <p>
 197 <dl class="user" compact><dt><b>Note:</b></dt><dd>This requires that the backing iterator is a bidirectional iterator. </dd></dl>
 198
 199 </div>
 200 </div><p>
 201 <a class="anchor" name="24c0cef4d514f69fec6577f55dc93799"></a><!-- doxytag: member="Sylph::SylphIterator::hasNext" ref="24c0cef4d514f69fec6577f55dc93799" args="() const " -->
 202 <div class="memitem">
 203 <div class="memproto">
 204 <div class="memtemplate">
 205 template&lt;class Iter &gt; </div>
 206       <table class="memname">
 207         <tr>
 208           <td class="memname">virtual bool <a class="el" href="class_sylph_1_1_sylph_iterator.html">Sylph::SylphIterator</a>&lt; Iter &gt;::hasNext           </td>
 209           <td>(</td>
 210           <td class="paramname">          </td>
 211           <td>&nbsp;)&nbsp;</td>
 212           <td> const<code> [inline, virtual]</code></td>
 213         </tr>
 214       </table>
 215 </div>
 216 <div class="memdoc">
 217
 218 <p>
 219 Checks if this iterator has any more entries in forward direction.
 220 <p>
 221 <dl class="return" compact><dt><b>Returns:</b></dt><dd><em>true</em> if there are more entries, <em>false</em> otherwise. </dd></dl>
 222
 223 </div>
 224 </div><p>
 225 <a class="anchor" name="42de0477358aa16970ef257d041047e3"></a><!-- doxytag: member="Sylph::SylphIterator::hasPrevious" ref="42de0477358aa16970ef257d041047e3" args="() const " -->
 226 <div class="memitem">
 227 <div class="memproto">
 228 <div class="memtemplate">
 229 template&lt;class Iter &gt; </div>
 230       <table class="memname">
 231         <tr>
 232           <td class="memname">virtual bool <a class="el" href="class_sylph_1_1_sylph_iterator.html">Sylph::SylphIterator</a>&lt; Iter &gt;::hasPrevious           </td>
 233           <td>(</td>
 234           <td class="paramname">          </td>
 235           <td>&nbsp;)&nbsp;</td>
 236           <td> const<code> [inline, virtual]</code></td>
 237         </tr>
 238       </table>
 239 </div>
 240 <div class="memdoc">
 241
 242 <p>
 243 Checks if this iterator has any more entries in backward direction.
 244 <p>
 245 <dl class="return" compact><dt><b>Returns:</b></dt><dd><em>true</em> if there are more entries, <em>false</em> otherwise. </dd></dl>
 246 <dl class="user" compact><dt><b>Note:</b></dt><dd>This requires that the backing iterator is a bidirectional iterator. </dd></dl>
 247
 248 </div>
 249 </div><p>
 250 <a class="anchor" name="5cafc479cfa2742212ed80b4e1b03a4e"></a><!-- doxytag: member="Sylph::SylphIterator::next" ref="5cafc479cfa2742212ed80b4e1b03a4e" args="() const " -->
 251 <div class="memitem">
 252 <div class="memproto">
 253 <div class="memtemplate">
 254 template&lt;class Iter &gt; </div>
 255       <table class="memname">
 256         <tr>
 257           <td class="memname">virtual const Iter::reference <a class="el" href="class_sylph_1_1_sylph_iterator.html">Sylph::SylphIterator</a>&lt; Iter &gt;::next           </td>
 258           <td>(</td>
 259           <td class="paramname">          </td>
 260           <td>&nbsp;)&nbsp;</td>
 261           <td> const<code> [inline, virtual]</code></td>
 262         </tr>
 263       </table>
 264 </div>
 265 <div class="memdoc">
 266
 267 <p>
 268 Returns the next entry in the forward direction and moves the iterator one place forward.
 269 <p>
 270 <dl compact><dt><b>Exceptions:</b></dt><dd>
 271   <table border="0" cellspacing="2" cellpadding="0">
 272     <tr><td valign="top"></td><td valign="top"><em><a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a></em>&nbsp;</td><td>if there are no more entries. </td></tr>
 273   </table>
 274 </dl>
 275 <dl class="return" compact><dt><b>Returns:</b></dt><dd>The next entry </dd></dl>
 276
 277 </div>
 278 </div><p>
 279 <a class="anchor" name="fe653e20cc020e9fea58b2e0b8be8ab9"></a><!-- doxytag: member="Sylph::SylphIterator::nextIndex" ref="fe653e20cc020e9fea58b2e0b8be8ab9" args="() const " -->
 280 <div class="memitem">
 281 <div class="memproto">
 282 <div class="memtemplate">
 283 template&lt;class Iter &gt; </div>
 284       <table class="memname">
 285         <tr>
 286           <td class="memname">virtual std::idx_t <a class="el" href="class_sylph_1_1_sylph_iterator.html">Sylph::SylphIterator</a>&lt; Iter &gt;::nextIndex           </td>
 287           <td>(</td>
 288           <td class="paramname">          </td>
 289           <td>&nbsp;)&nbsp;</td>
 290           <td> const<code> [inline, virtual]</code></td>
 291         </tr>
 292       </table>
 293 </div>
 294 <div class="memdoc">
 295
 296 <p>
 297 Returns the next index of the Iterable in the forward direction.
 298 <p>
 299 <dl compact><dt><b>Exceptions:</b></dt><dd>
 300   <table border="0" cellspacing="2" cellpadding="0">
 301     <tr><td valign="top"></td><td valign="top"><em><a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a></em>&nbsp;</td><td>if there are no more entries. </td></tr>
 302   </table>
 303 </dl>
 304 <dl class="return" compact><dt><b>Returns:</b></dt><dd>The next index in the Iterable </dd></dl>
 305 <dl class="user" compact><dt><b>Note:</b></dt><dd>This method requires the backing iterator to be a random-access iterator. </dd></dl>
 306
 307 </div>
 308 </div><p>
 309 <a class="anchor" name="3ea8e165a6e4438fcb82f86117f0b16d"></a><!-- doxytag: member="Sylph::SylphIterator::operator++" ref="3ea8e165a6e4438fcb82f86117f0b16d" args="(int) const " -->
 310 <div class="memitem">
 311 <div class="memproto">
 312 <div class="memtemplate">
 313 template&lt;class Iter &gt; </div>
 314       <table class="memname">
 315         <tr>
 316           <td class="memname">const Iter::reference <a class="el" href="class_sylph_1_1_sylph_iterator.html">Sylph::SylphIterator</a>&lt; Iter &gt;::operator++           </td>
 317           <td>(</td>
 318           <td class="paramtype">int&nbsp;</td>
 319           <td class="paramname">          </td>
 320           <td>&nbsp;)&nbsp;</td>
 321           <td> const<code> [inline]</code></td>
 322         </tr>
 323       </table>
 324 </div>
 325 <div class="memdoc">
 326
 327 <p>
 328 Synoynmous for <a class="el" href="class_sylph_1_1_sylph_iterator.html#5cafc479cfa2742212ed80b4e1b03a4e" title="Returns the next entry in the forward direction and moves the iterator one place...">next()</a>.
 329 <p>
 330 <dl class="user" compact><dt><b>Note:</b></dt><dd>No copy of this iterator is made. </dd></dl>
 331
 332 </div>
 333 </div><p>
 334 <a class="anchor" name="40260b5a6935ec8b2403680e34e9e91f"></a><!-- doxytag: member="Sylph::SylphIterator::operator&#45;&#45;" ref="40260b5a6935ec8b2403680e34e9e91f" args="(int) const " -->
 335 <div class="memitem">
 336 <div class="memproto">
 337 <div class="memtemplate">
 338 template&lt;class Iter &gt; </div>
 339       <table class="memname">
 340         <tr>
 341           <td class="memname">const Iter::reference <a class="el" href="class_sylph_1_1_sylph_iterator.html">Sylph::SylphIterator</a>&lt; Iter &gt;::operator--           </td>
 342           <td>(</td>
 343           <td class="paramtype">int&nbsp;</td>
 344           <td class="paramname">          </td>
 345           <td>&nbsp;)&nbsp;</td>
 346           <td> const<code> [inline]</code></td>
 347         </tr>
 348       </table>
 349 </div>
 350 <div class="memdoc">
 351
 352 <p>
 353 Synonymous for <a class="el" href="class_sylph_1_1_sylph_iterator.html#3277c644458465f50deb6713d308309c" title="Returns the next entry in the backward direction and moves the iterator one place...">previous()</a>.
 354 <p>
 355 <dl class="user" compact><dt><b>Note:</b></dt><dd>No copy is of this iterator is made. </dd></dl>
 356
 357 </div>
 358 </div><p>
 359 <a class="anchor" name="3277c644458465f50deb6713d308309c"></a><!-- doxytag: member="Sylph::SylphIterator::previous" ref="3277c644458465f50deb6713d308309c" args="() const " -->
 360 <div class="memitem">
 361 <div class="memproto">
 362 <div class="memtemplate">
 363 template&lt;class Iter &gt; </div>
 364       <table class="memname">
 365         <tr>
 366           <td class="memname">virtual const Iter::reference <a class="el" href="class_sylph_1_1_sylph_iterator.html">Sylph::SylphIterator</a>&lt; Iter &gt;::previous           </td>
 367           <td>(</td>
 368           <td class="paramname">          </td>
 369           <td>&nbsp;)&nbsp;</td>
 370           <td> const<code> [inline, virtual]</code></td>
 371         </tr>
 372       </table>
 373 </div>
 374 <div class="memdoc">
 375
 376 <p>
 377 Returns the next entry in the backward direction and moves the iterator one place backward.
 378 <p>
 379 <dl compact><dt><b>Exceptions:</b></dt><dd>
 380   <table border="0" cellspacing="2" cellpadding="0">
 381     <tr><td valign="top"></td><td valign="top"><em><a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a></em>&nbsp;</td><td>if there are no more entries. </td></tr>
 382   </table>
 383 </dl>
 384 <dl class="return" compact><dt><b>Returns:</b></dt><dd>The previous entry </dd></dl>
 385 <dl class="user" compact><dt><b>Note:</b></dt><dd>This requires that the backing iterator is a bidirectional iterator. </dd></dl>
 386
 387 </div>
 388 </div><p>
 389 <a class="anchor" name="9966f87c9c01a9a13523a34568989124"></a><!-- doxytag: member="Sylph::SylphIterator::previousIndex" ref="9966f87c9c01a9a13523a34568989124" args="() const " -->
 390 <div class="memitem">
 391 <div class="memproto">
 392 <div class="memtemplate">
 393 template&lt;class Iter &gt; </div>
 394       <table class="memname">
 395         <tr>
 396           <td class="memname">virtual std::idx_t <a class="el" href="class_sylph_1_1_sylph_iterator.html">Sylph::SylphIterator</a>&lt; Iter &gt;::previousIndex           </td>
 397           <td>(</td>
 398           <td class="paramname">          </td>
 399           <td>&nbsp;)&nbsp;</td>
 400           <td> const<code> [inline, virtual]</code></td>
 401         </tr>
 402       </table>
 403 </div>
 404 <div class="memdoc">
 405
 406 <p>
 407 Returns the next index of the Iterable in the backward direction.
 408 <p>
 409 <dl compact><dt><b>Exceptions:</b></dt><dd>
 410   <table border="0" cellspacing="2" cellpadding="0">
 411     <tr><td valign="top"></td><td valign="top"><em><a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a></em>&nbsp;</td><td>if there are no more entries. </td></tr>
 412   </table>
 413 </dl>
 414 <dl class="return" compact><dt><b>Returns:</b></dt><dd>The previous index in the Iterable </dd></dl>
 415 <dl class="user" compact><dt><b>Note:</b></dt><dd>This method requires the backing iterator to be a random-access iterator. </dd></dl>
 416
 417 </div>
 418 </div><p>
 419 <a class="anchor" name="dea685b03c30249496bdd82f303323d5"></a><!-- doxytag: member="Sylph::SylphIterator::set" ref="dea685b03c30249496bdd82f303323d5" args="(typename Iter::reference t)" -->
 420 <div class="memitem">
 421 <div class="memproto">
 422 <div class="memtemplate">
 423 template&lt;class Iter &gt; </div>
 424       <table class="memname">
 425         <tr>
 426           <td class="memname">virtual void <a class="el" href="class_sylph_1_1_sylph_iterator.html">Sylph::SylphIterator</a>&lt; Iter &gt;::set           </td>
 427           <td>(</td>
 428           <td class="paramtype">typename Iter::reference&nbsp;</td>
 429           <td class="paramname"> <em>t</em>          </td>
 430           <td>&nbsp;)&nbsp;</td>
 431           <td><code> [inline, virtual]</code></td>
 432         </tr>
 433       </table>
 434 </div>
 435 <div class="memdoc">
 436
 437 <p>
 438 Replaces the last item returned by <a class="el" href="class_sylph_1_1_sylph_iterator.html#5cafc479cfa2742212ed80b4e1b03a4e" title="Returns the next entry in the forward direction and moves the iterator one place...">next()</a> or <a class="el" href="class_sylph_1_1_sylph_iterator.html#3277c644458465f50deb6713d308309c" title="Returns the next entry in the backward direction and moves the iterator one place...">previous()</a> with the given item.
 439 <p>
 440 <dl compact><dt><b>Parameters:</b></dt><dd>
 441   <table border="0" cellspacing="2" cellpadding="0">
 442     <tr><td valign="top"></td><td valign="top"><em>t</em>&nbsp;</td><td>The item to replace the last returned item with. </td></tr>
 443   </table>
 444 </dl>
 445
 446 </div>
 447 </div><p>
 448 </div>
 449 <hr size="1" class="unhidden"><address style="text-align: right;"><small>
 450 Documentation for LibSylph by Doxygen
 451 </body>
 452 </html>