docs/html/class_sylph_1_1_array_1_1iterator.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::Array&lt; T &gt;::Array::iterator Class 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_array.html">Array</a>::<a class="el" href="class_sylph_1_1_array_1_1iterator.html">iterator</a>
  25   </div>
  26 </div>
  27 <div class="contents">
  28 <h1>Sylph::Array&lt; T &gt;::Array::iterator Class Reference</h1><!-- doxytag: class="Sylph::Array::iterator" --><!-- doxytag: inherits="RandomAccessIterator&lt; T, iterator &gt;" --><code>#include &lt;<a class="el" href="_array_8h-source.html">Sylph/Core/Array.h</a>&gt;</code>
  29 <p>
  30 <div class="dynheader">
  31 Inheritance diagram for Sylph::Array&lt; T &gt;::Array::iterator:</div>
  32 <div class="dynsection">
  33 <p><center><img src="class_sylph_1_1_array_1_1iterator__inherit__graph.png" border="0" usemap="#_sylph_1_1_array_3_01_t_01_4_1_1_array_1_1iterator__inherit__map" alt="Inheritance graph"></center>
  34 <map name="_sylph_1_1_array_3_01_t_01_4_1_1_array_1_1iterator__inherit__map">
  35 <area shape="rect" id="node2" href="class_sylph_1_1_random_access_iterator.html" title="Sylph::RandomAccessIterator\&lt; T, iterator \&gt;" alt="" coords="5,237,325,267"><area shape="rect" id="node4" href="class_sylph_1_1_bidirectional_iterator.html" title="Sylph::BidirectionalIterator\&lt; T, iterator \&gt;" alt="" coords="16,160,315,189"><area shape="rect" id="node6" href="class_sylph_1_1_forward_iterator.html" title="Sylph::ForwardIterator\&lt; T, iterator \&gt;" alt="" coords="31,83,300,112"><area shape="rect" id="node8" href="class_sylph_1_1_object.html" title="The root of all classes." alt="" coords="109,5,221,35"></map>
  36 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
  37
  38 <p>
  39 <a href="class_sylph_1_1_array_1_1iterator-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  40 <tr><td></td></tr>
  41 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  42 <tr><td class="memItemLeft" nowrap align="right" valign="top">super::reference&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_array_1_1iterator.html#22bfc5f805fcbc5917ae279f451e110f">current</a> () const </td></tr>
  43
  44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><b>OVERRIDE THIS METHOD</b> Returns a reference to the object the <a class="el" href="class_sylph_1_1_array_1_1iterator.html">iterator</a> is currently pointing at.  <a href="#22bfc5f805fcbc5917ae279f451e110f"></a><br></td></tr>
  45 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_array_1_1iterator.html#6dcf01f3b483a19c96faf73c8c829ce9">hasNext</a> () const </td></tr>
  46
  47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><b>OVERRIDE THIS METHOD</b> Tells wheter there are any objects left in the collection.  <a href="#6dcf01f3b483a19c96faf73c8c829ce9"></a><br></td></tr>
  48 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_array_1_1iterator.html#3c1145de7f34e2f9ad853369e418be0a">next</a> () const </td></tr>
  49
  50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><b>OVERRIDE THIS METHOD</b> Sets the <a class="el" href="class_sylph_1_1_array_1_1iterator.html">iterator</a> one place forward.  <a href="#3c1145de7f34e2f9ad853369e418be0a"></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_forward_iterator.html#6bc12e11b0e540d8788e8eab0cad19cd">equals</a> (const <a class="el" href="class_sylph_1_1_array_1_1iterator.html">iterator</a> &amp;other) const =0</td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><b>OVERRIDE THIS METHOD</b> Tells wheter this Iterator is equal to any other Iterator over the same type of collection.  <a href="#6bc12e11b0e540d8788e8eab0cad19cd"></a><br></td></tr>
  54 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
  55 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1448ef46fc3bf3ac2e65ed03eba0cb33"></a><!-- doxytag: member="Sylph::Array::iterator::_end_reached_" ref="1448ef46fc3bf3ac2e65ed03eba0cb33" args="" -->
  56 bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_forward_iterator.html#1448ef46fc3bf3ac2e65ed03eba0cb33">_end_reached_</a></td></tr>
  57
  58 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Do not use or modify! <br></td></tr>
  59 </table>
  60 <hr><a name="_details"></a><h2>Detailed Description</h2>
  61 <h3>template&lt;class T&gt;<br>
  62  class Sylph::Array&lt; T &gt;::iterator</h3>
  63
  64 <dl compact><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Write documentation! </dd></dl>
  65 <hr><h2>Member Function Documentation</h2>
  66 <a class="anchor" name="22bfc5f805fcbc5917ae279f451e110f"></a><!-- doxytag: member="Sylph::Array::iterator::current" ref="22bfc5f805fcbc5917ae279f451e110f" args="() const " -->
  67 <div class="memitem">
  68 <div class="memproto">
  69 <div class="memtemplate">
  70 template&lt;class T&gt; </div>
  71       <table class="memname">
  72         <tr>
  73           <td class="memname">super::reference <a class="el" href="class_sylph_1_1_array.html">Sylph::Array</a>&lt; T &gt;::Array::iterator::current           </td>
  74           <td>(</td>
  75           <td class="paramname">          </td>
  76           <td>&nbsp;)&nbsp;</td>
  77           <td> const<code> [inline, virtual]</code></td>
  78         </tr>
  79       </table>
  80 </div>
  81 <div class="memdoc">
  82
  83 <p>
  84 <b>OVERRIDE THIS METHOD</b> Returns a reference to the object the <a class="el" href="class_sylph_1_1_array_1_1iterator.html">iterator</a> is currently pointing at.
  85 <p>
  86 Note that no beyond-the-end checking needs to be done, this is all done automagically for you. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The object this <a class="el" href="class_sylph_1_1_array_1_1iterator.html">iterator</a> is currently pointing at. </dd></dl>
  87
  88 <p>Implements <a class="el" href="class_sylph_1_1_forward_iterator.html#0cfbb6d989c3cbbd37947fb1fa68ee24">Sylph::ForwardIterator&lt; T, iterator &gt;</a>.</p>
  89
  90 </div>
  91 </div><p>
  92 <a class="anchor" name="6bc12e11b0e540d8788e8eab0cad19cd"></a><!-- doxytag: member="Sylph::Array::iterator::equals" ref="6bc12e11b0e540d8788e8eab0cad19cd" args="(const iterator &amp;other) const =0" -->
  93 <div class="memitem">
  94 <div class="memproto">
  95       <table class="memname">
  96         <tr>
  97           <td class="memname">virtual bool <a class="el" href="class_sylph_1_1_forward_iterator.html">Sylph::ForwardIterator</a>&lt; T , <a class="el" href="class_sylph_1_1_array_1_1iterator.html">iterator</a>  &gt;::equals           </td>
  98           <td>(</td>
  99           <td class="paramtype">const iterator  &amp;&nbsp;</td>
 100           <td class="paramname"> <em>other</em>          </td>
 101           <td>&nbsp;)&nbsp;</td>
 102           <td> const<code> [pure virtual, inherited]</code></td>
 103         </tr>
 104       </table>
 105 </div>
 106 <div class="memdoc">
 107
 108 <p>
 109 <b>OVERRIDE THIS METHOD</b> Tells wheter this Iterator is equal to any other Iterator over the same type of collection.
 110 <p>
 111 <dl compact><dt><b>Parameters:</b></dt><dd>
 112   <table border="0" cellspacing="2" cellpadding="0">
 113     <tr><td valign="top"></td><td valign="top"><em>other</em>&nbsp;</td><td>An other ForwardIterator to compare this one against. </td></tr>
 114   </table>
 115 </dl>
 116 <dl class="return" compact><dt><b>Returns:</b></dt><dd><em>true</em> iff the two iterators are completely equal (i.e. they iteratate over the same collection and currently point to the same object), false otherwise. </dd></dl>
 117
 118 </div>
 119 </div><p>
 120 <a class="anchor" name="6dcf01f3b483a19c96faf73c8c829ce9"></a><!-- doxytag: member="Sylph::Array::iterator::hasNext" ref="6dcf01f3b483a19c96faf73c8c829ce9" args="() const " -->
 121 <div class="memitem">
 122 <div class="memproto">
 123 <div class="memtemplate">
 124 template&lt;class T&gt; </div>
 125       <table class="memname">
 126         <tr>
 127           <td class="memname">bool <a class="el" href="class_sylph_1_1_array.html">Sylph::Array</a>&lt; T &gt;::Array::iterator::hasNext           </td>
 128           <td>(</td>
 129           <td class="paramname">          </td>
 130           <td>&nbsp;)&nbsp;</td>
 131           <td> const<code> [inline, virtual]</code></td>
 132         </tr>
 133       </table>
 134 </div>
 135 <div class="memdoc">
 136
 137 <p>
 138 <b>OVERRIDE THIS METHOD</b> Tells wheter there are any objects left in the collection.
 139 <p>
 140 This method should not take the past-the-end item into account. <dl class="return" compact><dt><b>Returns:</b></dt><dd><em>true</em> true if there are any next items, <em>false</em> if there are no more items left. </dd></dl>
 141
 142 <p>Implements <a class="el" href="class_sylph_1_1_forward_iterator.html#0c368995da59e9b3a2074bfccf8ac708">Sylph::ForwardIterator&lt; T, iterator &gt;</a>.</p>
 143
 144 </div>
 145 </div><p>
 146 <a class="anchor" name="3c1145de7f34e2f9ad853369e418be0a"></a><!-- doxytag: member="Sylph::Array::iterator::next" ref="3c1145de7f34e2f9ad853369e418be0a" args="() const " -->
 147 <div class="memitem">
 148 <div class="memproto">
 149 <div class="memtemplate">
 150 template&lt;class T&gt; </div>
 151       <table class="memname">
 152         <tr>
 153           <td class="memname">void <a class="el" href="class_sylph_1_1_array.html">Sylph::Array</a>&lt; T &gt;::Array::iterator::next           </td>
 154           <td>(</td>
 155           <td class="paramname">          </td>
 156           <td>&nbsp;)&nbsp;</td>
 157           <td> const<code> [inline, virtual]</code></td>
 158         </tr>
 159       </table>
 160 </div>
 161 <div class="memdoc">
 162
 163 <p>
 164 <b>OVERRIDE THIS METHOD</b> Sets the <a class="el" href="class_sylph_1_1_array_1_1iterator.html">iterator</a> one place forward.
 165 <p>
 166 Note that no beyond-the-end checking needs to be done, this is all done automagically for you.
 167 <p>Implements <a class="el" href="class_sylph_1_1_forward_iterator.html#c51a9015adb5e22568530c70efd6ff40">Sylph::ForwardIterator&lt; T, iterator &gt;</a>.</p>
 168
 169 </div>
 170 </div><p>
 171 </div>
 172 <hr size="1" class="unhidden"><address style="text-align: right;"><small>
 173 Documentation for LibSylph by Doxygen
 174 </body>
 175 </html>