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
|
<?xml version="1.0"?>
<concept name="ForwardIterator" category="Iterator"><!--
Based on concepts from the SGI Standard Template Library documentation:
Copyright (c) 1996-1999
Silicon Graphics Computer Systems, Inc.
Copyright (c) 1994
Hewlett-Packard Company
--><!--
Copyright 2000-2001 University of Notre Dame du Lac.
Copyright 2001-2002 Indiana University.
Some concepts based on versions from the MTL draft manual and Boost Graph
and Property Map documentation:
Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000
-->
<!--
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.
-->
<param name="Iter" role="iterator-type"/>
<use-header name="iterator"/>
<models-sentence>The iterator type <arg num="1"/> must be a model of <self/>.</models-sentence>
<description>
<para>A forward iterator is an iterator that can read through a sequence of
values. It is multi-pass (old values of the iterator can be
re-used), and can be either mutable (data pointed to by it can be
changed) or not mutable.</para>
<para>An iterator represents a position in a sequence. Therefore, the
iterator can point into the sequence (returning a value when dereferenced
and being incrementable), or be off-the-end (and not dereferenceable or
incrementable).</para>
</description>
<associated-type name="value_type">
<get-member-type name="value_type">
<apply-template name="std::iterator_traits">
<type name="Iter"/>
</apply-template>
</get-member-type>
<description><simpara>The value type of the iterator</simpara></description>
</associated-type>
<refines const="no" concept="InputIterator"/>
<refines const="no" concept="OutputIterator"/>
<!-- DPG doesn't understand this
<models const="no" testable="yes" concept="Input Iterator">
<type name="Iter"/>
</models>
-->
<!--
<models-when-mutable concept="Output Iterator">
<type name="Iter"/>
<type name="value_type"/>
</models-when-mutable>
-->
<notation variables="i j">
<sample-value>
<type name="Iter"/>
</sample-value>
</notation>
<associated-type name="category">
<get-member-type name="iterator_category">
<apply-template name="std::iterator_traits">
<type name="Iter"/>
</apply-template>
</get-member-type>
<description><simpara>The category of the iterator</simpara></description>
</associated-type>
<notation variables="x">
<sample-value>
<type name="value_type"/>
</sample-value>
</notation>
<valid-type-expression name="Category tag">
<description/>
<type name="category"/>
<return-type>
<derived-from testable="yes">
<type name="std::forward_iterator_tag"/>
</derived-from>
</return-type>
</valid-type-expression>
<valid-expression name="Dereference">
<dereference>
<sample-value><type name="Iter"/></sample-value>
</dereference>
<return-type>
<require-same-type testable="yes">
<const-if-not-mutable>
<reference-to><type name="value_type"/></reference-to>
</const-if-not-mutable>
</require-same-type>
</return-type>
<precondition><code>i</code> is incrementable (not
off-the-end)</precondition>
</valid-expression>
<valid-expression name="Member access">
<pointer-member>
<sample-value><type name="Iter"/></sample-value>
</pointer-member>
<return-type>
<require-same-type testable="yes">
<const-if-not-mutable>
<pointer-to><type name="value_type"/></pointer-to>
</const-if-not-mutable>
</require-same-type>
</return-type>
<precondition><code>i</code> is incrementable (not
off-the-end)</precondition>
</valid-expression>
<valid-expression name="Preincrement">
<preincrement>
<sample-value><reference-to><type name="Iter"/></reference-to></sample-value>
</preincrement>
<return-type>
<require-same-type testable="yes">
<reference-to><type name="Iter"/></reference-to>
</require-same-type>
</return-type>
<precondition><code>i</code> is incrementable (not
off-the-end)</precondition>
</valid-expression>
<valid-expression name="Postincrement">
<postincrement>
<sample-value><reference-to><type name="Iter"/></reference-to></sample-value>
</postincrement>
<return-type>
<require-same-type testable="yes"><type name="Iter"/></require-same-type>
</return-type>
<precondition><code>i</code> is incrementable (not
off-the-end)</precondition>
<semantics>Equivalent to <code>{Iter j = i; ++i; return j;}</code></semantics>
<postcondition><code>i</code> is dereferenceable or
off-the-end</postcondition>
</valid-expression>
<complexity>
All iterator operations must take amortized constant time.
</complexity>
<invariant name="Predecrement must return object">
<code>&i = &(++i)</code>
</invariant>
<invariant name="Unique path through sequence">
<code>i == j</code> implies <code>++i == ++j</code>
</invariant>
<example-model>
<pointer-to>
<type name="T"/>
</pointer-to>
</example-model>
<example-model>
<get-member-type name="iterator">
<apply-template name="std::hash_set">
<type name="T"/>
</apply-template>
</get-member-type>
</example-model>
<see-also concept="BidirectionalIterator"/>
</concept>
|
