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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
|
<HTML>
<!--
-- Copyright (c) 1996,1997
-- 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>Random Access Iterator</Title>
<!-- Generated by htmldoc -->
</HEAD>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
ALINK="#ff0000">
<IMG SRC="CorpID.gif"
ALT="Silicon Graphics, Inc." HEIGHT="43" WIDTH="151">
<!--end header-->
<BR Clear>
<H1>Random Access 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 Random Access Iterator is an iterator that provides both
increment and decrement (just like a <A href="BidirectionalIterator.html">Bidirectional Iterator</A>),
and that also provides constant-time methods for moving forward
and backward in arbitrary-sized steps. Random Access Iterators
provide essentially all of the operations of ordinary
C pointer arithmetic.
<h3>Refinement of</h3>
<A href="BidirectionalIterator.html">Bidirectional Iterator</A>, <A href="LessThanComparable.html">LessThan Comparable</A>
<h3>Associated types</h3>
The same as for <A href="BidirectionalIterator.html">Bidirectional Iterator</A>
<h3>Notation</h3>
<Table>
<TR>
<TD VAlign=top>
<tt>X</tt>
</TD>
<TD VAlign=top>
A type that is a model of Random Access 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>Distance</tt>
</TD>
<TD VAlign=top>
The distance 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>
<TR>
<TD VAlign=top>
<tt>n</tt>
</TD>
<TD VAlign=top>
Object of type <tt>Distance</tt>
</TD>
</tr>
</table>
<h3>Definitions</h3>
<h3>Valid expressions</h3>
In addition to the expressions defined in <A href="BidirectionalIterator.html">Bidirectional Iterator</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>
Iterator addition
</TD>
<TD VAlign=top>
<tt>i += n</tt>
</TD>
<TD VAlign=top>
</TD>
<TD VAlign=top>
<tt>X&</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
Iterator addition
</TD>
<TD VAlign=top>
<tt>i + n</tt> or <tt>n + i</tt>
</TD>
<TD VAlign=top>
</TD>
<TD VAlign=top>
<tt>X</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
Iterator subtraction
</TD>
<TD VAlign=top>
<tt>i -= n</tt>
</TD>
<TD VAlign=top>
</TD>
<TD VAlign=top>
<tt>X&</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
Iterator subtraction
</TD>
<TD VAlign=top>
<tt>i - n</tt>
</TD>
<TD VAlign=top>
</TD>
<TD VAlign=top>
<tt>X</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
Difference
</TD>
<TD VAlign=top>
<tt>i - j</tt>
</TD>
<TD VAlign=top>
</TD>
<TD VAlign=top>
<tt>Distance</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
Element operator
</TD>
<TD VAlign=top>
<tt>i[n]</tt>
</TD>
<TD VAlign=top>
</TD>
<TD VAlign=top>
Convertible to <tt>T</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
Element assignment
</TD>
<TD VAlign=top>
<tt>i[n] = t</tt>
</TD>
<TD VAlign=top>
<tt>X</tt> is mutable
</TD>
<TD VAlign=top>
Convertible to <tt>T</tt>
</TD>
</tr>
</table>
<h3>Expression semantics</h3>
Semantics of an expression is defined only where it differs from,
or is not defined in, <A href="BidirectionalIterator.html">Bidirectional Iterator</A> or
<A href="LessThanComparable.html">LessThan Comparable</A>.
<Table border>
<TR>
<TH>
Name
</TH>
<TH>
Expression
</TH>
<TH>
Precondition
</TH>
<TH>
Semantics
</TH>
<TH>
Postcondition
</TH>
</TR>
<TR>
<TD VAlign=top>
Forward motion
</TD>
<TD VAlign=top>
<tt>i += n</tt>
</TD>
<TD VAlign=top>
Including <tt>i</tt> itself, there must be <tt>n</tt> dereferenceable or
past-the-end iterators following or preceding <tt>i</tt>, depending
on whether <tt>n</tt> is positive or negative.
</TD>
<TD VAlign=top>
If <tt>n > 0</tt>, equivalent to executing <tt>++i</tt> <tt>n</tt> times. If <tt>n < 0</tt>,
equivalent to executing <tt>--i</tt> <tt>n</tt> times. If <tt>n == 0</tt>, this is
a null operation. <A href="#1">[1]</A>
</TD>
<TD VAlign=top>
<tt>i</tt> is dereferenceable or past-the-end.
</TD>
</TR>
<TR>
<TD VAlign=top>
Iterator addition
</TD>
<TD VAlign=top>
<tt>i + n</tt> or <tt>n + i</tt>
</TD>
<TD VAlign=top>
Same as for <tt>i += n</tt>
</TD>
<TD VAlign=top>
Equivalent to <tt>{ X tmp = i; return tmp += n; }</tt>. The two forms
<tt>i + n</tt> and <tt>n + i</tt> are identical.
</TD>
<TD VAlign=top>
Result is dereferenceable or past-the-end
</TD>
</TR>
<TR>
<TD VAlign=top>
Iterator subtraction
</TD>
<TD VAlign=top>
<tt>i -= n</tt>
</TD>
<TD VAlign=top>
Including <tt>i</tt> itself, there must be <tt>n</tt> dereferenceable or
past-the-end iterators preceding or following <tt>i</tt>, depending
on whether <tt>n</tt> is positive or negative.
</TD>
<TD VAlign=top>
Equivalent to <tt>i += (-n)</tt>.
</TD>
<TD VAlign=top>
<tt>i</tt> is dereferenceable or past-the-end.
</TD>
</TR>
<TR>
<TD VAlign=top>
Iterator subtraction
</TD>
<TD VAlign=top>
<tt>i - n</tt>
</TD>
<TD VAlign=top>
Same as for <tt>i -= n</tt>
</TD>
<TD VAlign=top>
Equivalent to <tt>{ X tmp = i; return tmp -= n; }</tt>.
</TD>
<TD VAlign=top>
Result is dereferenceable or past-the-end
</TD>
</TR>
<TR>
<TD VAlign=top>
Difference
</TD>
<TD VAlign=top>
<tt>i - j</tt>
</TD>
<TD VAlign=top>
Either <tt>i</tt> is reachable from <tt>j</tt> or <tt>j</tt> is reachable from <tt>i</tt>, or both.
</TD>
<TD VAlign=top>
Returns a number <tt>n</tt> such that <tt>i == j + n</tt>
</TD>
<TD VAlign=top>
</TD>
</TR>
<TR>
<TD VAlign=top>
Element operator
</TD>
<TD VAlign=top>
<tt>i[n]</tt>
</TD>
<TD VAlign=top>
<tt>i + n</tt> exists and is dereferenceable.
</TD>
<TD VAlign=top>
Equivalent to <tt>*(i + n)</tt> <A href="#2">[2]</A>
</TD>
<TD VAlign=top>
</TD>
</TR>
<TR>
<TD VAlign=top>
Element assignment
</TD>
<TD VAlign=top>
<tt>i[n] = t</tt>
</TD>
<TD VAlign=top>
<tt>i + n</tt> exists and is dereferenceable.
</TD>
<TD VAlign=top>
Equivalent to <tt>*(i + n) = t</tt> <A href="#2">[2]</A>
</TD>
<TD VAlign=top>
<tt>i[n]</tt> is a copy of <tt>t</tt>.
</TD>
</TR>
<TR>
<TD VAlign=top>
Less
</TD>
<TD VAlign=top>
<tt>i < j</tt>
</TD>
<TD VAlign=top>
Either <tt>i</tt> is reachable from <tt>j</tt> or <tt>j</tt> is reachable from <tt>i</tt>, or both. <A href="#3">[3]</A>
</TD>
<TD VAlign=top>
As described in <A href="LessThanComparable.html">LessThan Comparable</A> <A href="#4">[4]</A>
</TD>
<TD VAlign=top>
</TD>
</tr>
</table>
<h3>Complexity guarantees</h3>
All operations on Random Access Iterators are amortized constant
time. <A href="#5">[5]</A>
<h3>Invariants</h3>
<Table border>
<TR>
<TD VAlign=top>
Symmetry of addition and subtraction
</TD>
<TD VAlign=top>
If <tt>i + n</tt> is well-defined, then <tt>i += n; i -= n;</tt> and <tt>(i + n) - n</tt>
are null operations. Similarly, if <tt>i - n</tt> is well-defined,
then <tt>i -= n; i += n;</tt> and <tt>(i - n) + n</tt> are null operations.
</TD>
</TR>
<TR>
<TD VAlign=top>
Relation between distance and addition
</TD>
<TD VAlign=top>
If <tt>i - j</tt> is well-defined, then <tt>i == j + (i - j)</tt>.
</TD>
</TR>
<TR>
<TD VAlign=top>
Reachability and distance
</TD>
<TD VAlign=top>
If <tt>i</tt> is reachable from <tt>j</tt>, then <tt>i - j >= 0</tt>.
</TD>
</TR>
<TR>
<TD VAlign=top>
Ordering
</TD>
<TD VAlign=top>
<tt>operator <</tt> is a strict weak ordering, as defined in
<A href="LessThanComparable.html">LessThan Comparable</A>.
</TD>
</tr>
</table>
<h3>Models</h3>
<UL>
<LI>
<tt>T*</tt>
<LI>
<tt><A href="Vector.html">vector</A><T>::iterator</tt>
<LI>
<tt><A href="Vector.html">vector</A><T>::const_iterator</tt>
<LI>
<tt><A href="Deque.html">deque</A><T>::iterator</tt>
<LI>
<tt><A href="Deque.html">deque</A><T>::const_iterator</tt>
</UL>
<h3>Notes</h3>
<P><A name="1">[1]</A>
"Equivalent to" merely means that <tt>i += n</tt> yields the same iterator
as if <tt>i</tt> had been incremented (decremented) <tt>n</tt> times. It does
not mean that this is how <tt>operator+=</tt> should be implemented; in fact,
this is not a permissible implementation. It is guaranteed that <tt>i += n</tt>
is amortized constant time, regardless of the magnitude of <tt>n</tt>. <A href="#5">[5]</A>
<P><A name="2">[2]</A>
One minor syntactic oddity: in C, if <tt>p</tt> is a pointer and
<tt>n</tt> is an int, then <tt>p[n]</tt> and <tt>n[p]</tt> are equivalent. This equivalence
is not guaranteed, however, for Random Access Iterators: only
<tt>i[n]</tt> need be supported. This isn't a terribly important restriction,
though, since the equivalence of <tt>p[n]</tt> and <tt>n[p]</tt> has essentially
no application except for obfuscated C contests.
<P><A name="3">[3]</A>
The precondition defined in <A href="LessThanComparable.html">LessThan Comparable</A> is that <tt>i</tt>
and <tt>j</tt> be in the domain of <tt>operator <</tt>. Essentially, then, this
is a definition of that domain: it is the set of pairs of iterators such
that one iterator is reachable from the other.
<P><A name="4">[4]</A>
All of the other comparison operators have the same domain and
are defined in terms of <tt>operator <</tt>, so they have exactly the same
semantics as described in <A href="LessThanComparable.html">LessThan Comparable</A>.
<P><A name="5">[5]</A>
This complexity guarantee is in fact the only reason why
Random Access Iterator exists as a distinct concept. Every
operation in iterator arithmetic can be defined for
<A href="BidirectionalIterator.html">Bidirectional Iterators</A>; in fact, that is exactly what the
algorithms <tt><A href="advance.html">advance</A></tt> and <tt><A href="distance.html">distance</A></tt> do. The distinction is
simply that the <A href="BidirectionalIterator.html">Bidirectional Iterator</A> implementations are
linear time, while Random Access Iterators are required to support
random access to elements in amortized constant time. This has
major implications for the sorts of algorithms that can sensibly
be written using the two types of iterators.
<h3>See also</h3>
<A href="LessThanComparable.html">LessThan Comparable</A>, <A href="trivial.html">Trivial Iterator</A>,
<A href="BidirectionalIterator.html">Bidirectional 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 ©
1996 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>
|
