File: ForwardContainer.html

package info (click to toggle)
stl-manual 3.30-4
  • links: PTS
  • area: main
  • in suites: sarge, woody
  • size: 4,088 kB
  • ctags: 4,449
  • sloc: cpp: 17,845; ansic: 2,842; makefile: 35
file content (331 lines) | stat: -rw-r--r-- 7,847 bytes parent folder | download | duplicates (7)
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
<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 Container</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 Container</H1>

<Table CellPadding=0 CellSpacing=0 width=100%>
<TR>
<TD Align=left><Img src = "containers.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>: containers</TD>
<TD Align=right VAlign=top><b>Component type</b>: concept</TD>
</TR>
</Table>

<h3>Description</h3>
A Forward Container is a <A href="Container.html">Container</A> whose
elements are arranged in a definite order: the ordering will not
change spontaneously from iteration to iteration.  The requirement of
a definite ordering allows the definition of element-by-element
equality (if the container's element type is
<A href="EqualityComparable.html">Equality Comparable</A>) and of
lexicographical ordering (if the container's element type is
<A href="LessThanComparable.html">LessThan Comparable</A>).
<P>
Iterators into a Forward Container satisfy the 
<A href="ForwardIterator.html">forward iterator</A> requirements;
consequently, Forward Containers support multipass algorithms and
allow multiple iterators into the same container to be active at the
same time.
<h3>Refinement of</h3>
<A href="Container.html">Container</A>,
<A href="EqualityComparable.html">EqualityComparable</A>,
<A href="LessThanComparable.html">LessThanComparable</A>
<h3>Associated types</h3>
No additional types beyond those defined in
<A href="Container.html">Container</A>.  However, the requirements for
the iterator type are strengthened: the iterator type must be a model
of <A href="ForwardIterator.html">Forward 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 Container
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>a</tt>, <tt>b</tt>
</TD>
<TD VAlign=top>
Object of type <tt>X</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>T</tt>
</TD>
<TD VAlign=top>
The value type of <tt>X</tt>
</TD>
</tr>
</table>
<h3>Definitions</h3>
<h3>Valid expressions</h3>
In addition to the expressions defined in
<A href="Container.html">Container</A>,
<A href="EqualityComparable.html">EqualityComparable</A>, and 
<A href="LessThanComparable.html">LessThanComparable</A>, the following
expressions must be valid.
<Table border>
<TR>
<TH>
Name
</TH>
<TH>
Expression
</TH>
<TH>
Type requirements
</TH>
<TH>
Return type
</TH>
</TR>
<TR>
<TD VAlign=top>
Equality
</TD>
<TD VAlign=top>
<tt>a == b</tt>
</TD>
<TD VAlign=top>
<tt>T</tt> is <A href="EqualityComparable.html">EqualityComparable</A>
</TD>
<TD VAlign=top>
Convertible to <tt>bool</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
Inequality
</TD>
<TD VAlign=top>
<tt>a != b</tt>
</TD>
<TD VAlign=top>
<tt>T</tt> is <A href="EqualityComparable.html">EqualityComparable</A>
</TD>
<TD VAlign=top>
Convertible to <tt>bool</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
Less
</TD>
<TD VAlign=top>
<tt>a &lt; b</tt>
</TD>
<TD VAlign=top>
<tt>T</tt> is <A href="LessThanComparable.html">LessThanComparable</A>
</TD>
<TD VAlign=top>
Convertible to <tt>bool</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
Greater
</TD>
<TD VAlign=top>
<tt>a &gt; b</tt>
</TD>
<TD VAlign=top>
<tt>T</tt> is <A href="LessThanComparable.html">LessThanComparable</A>
</TD>
<TD VAlign=top>
Convertible to <tt>bool</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
Less or equal
</TD>
<TD VAlign=top>
<tt>a &lt;= b</tt>
</TD>
<TD VAlign=top>
<tt>T</tt> is <A href="LessThanComparable.html">LessThanComparable</A>
</TD>
<TD VAlign=top>
Convertible to <tt>bool</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
Greater or equal
</TD>
<TD VAlign=top>
<tt>a &gt;= b</tt>
</TD>
<TD VAlign=top>
<tt>T</tt> is <A href="LessThanComparable.html">LessThanComparable</A>
</TD>
<TD VAlign=top>
Convertible to <tt>bool</tt>
</TD>
</tr>
</table>
<h3>Expression semantics</h3>
Semantics of an expression is defined only where it is not defined in
<A href="Container.html">Container</A>,
<A href="EqualityComparable.html">EqualityComparable</A>, or
<A href="LessThanComparable.html">LessThanComparable</A>, or where there
is additional information.
<Table border>
<TR>
<TH>
Name
</TH>
<TH>
Expression
</TH>
<TH>
Precondition
</TH>
<TH>
Semantics
</TH>
<TH>
Postcondition
</TH>
</TR>
<TR>
<TD VAlign=top>
Equality
</TD>
<TD VAlign=top>
<tt>a == b</tt>
</TD>
<TD VAlign=top>
&nbsp;
</TD>
<TD VAlign=top>
Returns <tt>true</tt> if <tt>a.size() == b.size()</tt> and if each element of <tt>a</tt>
   compares equal to the corresponding element of <tt>b</tt>. Otherwise
   returns <tt>false</tt>.
</TD>
<TD VAlign=top>
&nbsp;
</TD>
</TR>
<TR>
<TD VAlign=top>
Less
</TD>
<TD VAlign=top>
<tt>a &lt; b</tt>
</TD>
<TD VAlign=top>
&nbsp;
</TD>
<TD VAlign=top>
Equivalent to <tt><A href="lexicographical_compare.html">lexicographical_compare</A>(a,b)</tt>
</TD>
<TD VAlign=top>
&nbsp;
</TD>
</tr>
</table>
<h3>Complexity guarantees</h3>
The equality and inequality operations are linear in the
   container's size.
<h3>Invariants</h3>
<Table border>
<TR>
<TD VAlign=top>
Ordering
</TD>
<TD VAlign=top>
Two different iterations through a forward container will access
   its elements in the same order, providing that there have been
   no intervening mutative operations.
</TD>
</tr>
</table>
<h3>Models</h3>
<UL>
<LI>
 <A href="Vector.html">vector</A>
<LI>
 <A href="List.html">list</A>
<LI>
 <A href="Slist.html">slist</A>
<LI>
 <A href="Deque.html">deque</A>
<LI>
 <A href="set.html">set</A>
<LI>
 <A href="hash_set.html">hash_set</A>
<LI>
 <A href="Map.html">map</A>
<LI>
 <A href="hash_map.html">hash_map</A>
<LI>
 <A href="multiset.html">multiset</A>
<LI>
 <A href="hash_multiset.html">hash_multiset</A>
<LI>
 <A href="Multimap.html">multimap</A>
<LI>
 <A href="hash_multimap.html">hash_multimap</A>
</UL>
<h3>Notes</h3>
<h3>See also</h3>
The <A href="Iterators.html">iterator overview</A>,
<A href="ForwardIterator.html">Forward Iterator</A>,
 <A href="Sequence.html">Sequence</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 &copy; 
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>