1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
|
<HTML>
<!--
-- Copyright (c) 1996-1999
-- Silicon Graphics Computer Systems, Inc.
--
-- Permission to use, copy, modify, distribute and sell this software
-- and its documentation for any purpose is hereby granted without fee,
-- provided that the above copyright notice appears in all copies and
-- that both that copyright notice and this permission notice appear
-- in supporting documentation. Silicon Graphics makes no
-- representations about the suitability of this software for any
-- purpose. It is provided "as is" without express or implied warranty.
--
-- Copyright (c) 1994
-- Hewlett-Packard Company
--
-- Permission to use, copy, modify, distribute and sell this software
-- and its documentation for any purpose is hereby granted without fee,
-- provided that the above copyright notice appears in all copies and
-- that both that copyright notice and this permission notice appear
-- in supporting documentation. Hewlett-Packard Company makes no
-- representations about the suitability of this software for any
-- purpose. It is provided "as is" without express or implied warranty.
--
-->
<Head>
<Title>Forward Iterator</Title>
<!-- Generated by htmldoc -->
</HEAD>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
ALINK="#ff0000">
<IMG SRC="CorpID.gif"
ALT="SGI" HEIGHT="43" WIDTH="151">
<!--end header-->
<BR Clear>
<H1>Forward Iterator</H1>
<Table CellPadding=0 CellSpacing=0 width=100%>
<TR>
<TD Align=left><Img src = "iterators.gif" Alt="" WIDTH = "194" HEIGHT = "38" ></TD>
<TD Align=right><Img src = "concept.gif" Alt="" WIDTH = "194" HEIGHT = "38" ></TD>
</TR>
<TR>
<TD Align=left VAlign=top><b>Category</b>: iterators</TD>
<TD Align=right VAlign=top><b>Component type</b>: concept</TD>
</TR>
</Table>
<h3>Description</h3>
A Forward Iterator is an iterator that corresponds to the usual
intuitive notion of a linear sequence of values. It is possible to use
Forward Iterators (unlike <A href="InputIterator.html">Input Iterators</A> and <A href="OutputIterator.html">Output Iterators</A>)
in multipass algorithms. Forward Iterators do not, however, allow
stepping backwards through a sequence, but only, as the
name suggests, forward.
<P>
A type that is a model of Forward Iterator
may be either <i>mutable</i> or <i>immutable</i>, as defined in the <A href="trivial.html">Trivial Iterators</A>
requirements.
<h3>Refinement of</h3>
<A href="InputIterator.html">Input Iterator</A>, <A href="OutputIterator.html">Output Iterator</A>
<h3>Associated types</h3>
The same as for <A href="InputIterator.html">Input Iterator</A>
<h3>Notation</h3>
<Table>
<TR>
<TD VAlign=top>
<tt>X</tt>
</TD>
<TD VAlign=top>
A type that is a model of Forward Iterator
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>T</tt>
</TD>
<TD VAlign=top>
The value type of <tt>X</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>i</tt>, <tt>j</tt>
</TD>
<TD VAlign=top>
Object of type <tt>X</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>t</tt>
</TD>
<TD VAlign=top>
Object of type <tt>T</tt>
</TD>
</tr>
</table>
<h3>Definitions</h3>
<h3>Valid expressions</h3>
Forward Iterator does not define any new expressions beyond those
defined in <A href="InputIterator.html">Input Iterator</A>. However, some of the restrictions
described in <A href="InputIterator.html">Input Iterator</A> are relaxed.
<Table border>
<TR>
<TH>
Name
</TH>
<TH>
Expression
</TH>
<TH>
Type requirements
</TH>
<TH>
Return type
</TH>
</TR>
<TR>
<TD VAlign=top>
Preincrement
</TD>
<TD VAlign=top>
<tt>++i</tt>
</TD>
<TD VAlign=top>
</TD>
<TD VAlign=top>
<tt>X&</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
Postincrement
</TD>
<TD VAlign=top>
<tt>i++</tt>
</TD>
<TD VAlign=top>
</TD>
<TD VAlign=top>
<tt>X</tt>
</TD>
</tr>
</table>
<h3>Expression semantics</h3>
Forward Iterator does not define any new expressions beyond those
defined in <A href="InputIterator.html">Input Iterator</A>. However, some of the restrictions
described in <A href="InputIterator.html">Input Iterator</A> are relaxed.
<Table border>
<TR>
<TH>
Name
</TH>
<TH>
Expression
</TH>
<TH>
Precondition
</TH>
<TH>
Semantics
</TH>
<TH>
Postcondition
</TH>
</TR>
<TR>
<TD VAlign=top>
Preincrement
</TD>
<TD VAlign=top>
<tt>++i</tt>
</TD>
<TD VAlign=top>
<tt>i</tt> is dereferenceable
</TD>
<TD VAlign=top>
<tt>i</tt> points to the next value
</TD>
<TD VAlign=top>
<tt>i</tt> is dereferenceable or past-the-end. <tt>&i == &++i</tt>. If <tt>i == j</tt>, then
<tt>++i == ++j</tt>. <A href="#1">[1]</A>
</TD>
</TR>
<TR>
<TD VAlign=top>
Postincrement
</TD>
<TD VAlign=top>
<tt>i++</tt>
</TD>
<TD VAlign=top>
<tt>i</tt> is dereferenceable
</TD>
<TD VAlign=top>
Equivalent to <tt>{X tmp = i; ++i; return tmp;}</tt>
</TD>
<TD VAlign=top>
<tt>i</tt> is dereferenceable or past-the-end. <A href="#1">[1]</A>
</TD>
</tr>
</table>
<h3>Complexity guarantees</h3>
The complexity of operations on Forward Iterators is
guaranteed to be amortized constant time.
<h3>Invariants</h3>
<h3>Models</h3>
<UL>
<LI>
<tt>T*</tt>
<LI>
<tt><A href="hash_set.html">hash_set</A><T>::iterator</tt>
</UL>
<h3>Notes</h3>
<P><A name="1">[1]</A>
The restrictions described in <A href="InputIterator.html">Input Iterator</A> have been
removed. Incrementing a forward iterator does not invalidate copies
of the old value and it is guaranteed that, if <tt>i</tt> and <tt>j</tt> are
dereferenceable and <tt>i == j</tt>, then <tt>++i == ++j</tt>. As a consequence
of these two facts, it is possible to pass through the same
Forward Iterator twice.
<h3>See also</h3>
<A href="InputIterator.html">Input Iterator</A>, <A href="OutputIterator.html">Output Iterator</A>, <A href="BidirectionalIterator.html">Bidirectional Iterator</A>,
<A href="RandomAccessIterator.html">Random Access Iterator</A>, <A href="Iterators.html">Iterator overview</A>
<!--start footer-->
<HR SIZE="6">
<A href="http://www.sgi.com/"><IMG SRC="surf.gif" HEIGHT="54" WIDTH="54"
ALT="[Silicon Surf]"></A>
<A HREF="index.html"><IMG SRC="stl_home.gif"
HEIGHT="54" WIDTH="54" ALT="[STL Home]"></A>
<BR>
<FONT SIZE="-2">
<A href="http://www.sgi.com/Misc/sgi_info.html" TARGET="_top">Copyright ©
1999 Silicon Graphics, Inc.</A> All Rights Reserved.</FONT>
<FONT SIZE="-3"><a href="http://www.sgi.com/Misc/external.list.html" TARGET="_top">TrademarkInformation</A>
</FONT>
<P>
</BODY>
</HTML>
|