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
|
// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
#ifndef BALL_CONCEPT_FORWARDITERATOR_H
#define BALL_CONCEPT_FORWARDITERATOR_H
#ifndef BALL_CONCEPT_BASEITERATOR_H
# include <BALL/CONCEPT/baseIterator.h>
#endif
namespace BALL
{
/** @name Generic forward iterator classes
\ingroup ConceptsIterators
*/
//@{
/** Generic non-mutable forward itterator
*/
template <typename Container, typename DataType, typename Position, typename Traits>
class ConstForwardIterator
: public BaseIterator<Container, DataType, Position, Traits>
{
public:
/** @name Typedefs
*/
//@{
///
typedef std::forward_iterator_tag iterator_category;
// convenience typedef
typedef BaseIterator<Container, DataType, Position, Traits> Base;
//@}
/** @name Constructors and Destructors
*/
//@{
/// Default constructor
BALL_INLINE ConstForwardIterator() {}
/// Copy constructor
BALL_INLINE ConstForwardIterator(const ConstForwardIterator& iterator)
: BaseIterator<Container, DataType, Position, Traits>(iterator)
{
}
///
BALL_INLINE ~ConstForwardIterator() {}
//@}
/** @name Assignment
*/
//@{
///
BALL_INLINE ConstForwardIterator& operator = (const ConstForwardIterator& iterator)
{
BaseIterator<Container, DataType, Position, Traits>::operator = (iterator);
return *this;
}
///
BALL_INLINE void swap(ConstForwardIterator& iterator) { std::swap(ConstForwardIterator<Container, DataType, Position, Traits>::getTraits(), iterator.getTraits()); }
//@}
/** @name Iterator methods
*/
//@{
/** Move the iterator to the item at the beginning of the container
* \throws Exception::Precondition
*/
BALL_INLINE void toBegin();
/// Check whether the iterator points to the first item of the container
BALL_INLINE bool isBegin() const;
/** Move the iterator behind the last item of the container
* \throws Exception::Precondition
*/
BALL_INLINE void toEnd();
/// Check whether the iterator points behind the last item of the container
BALL_INLINE bool isEnd() const;
/** Return an iterator pointing to the beginning of the container
* \throws Exception::Precondition
*/
static ConstForwardIterator begin(const Container& container);
/** Return an iterator pointing at the end of the container
* \throws Exception::Precondition
*/
static ConstForwardIterator end(const Container& container);
/** Increment operator
* \throws Exception::Precondition
*/
BALL_INLINE ConstForwardIterator& operator ++ ()
{
BALL_PRECONDITION_EXCEPTION(Base::isValid(), "cannot increment invalid iterator")
Base::getTraits().forward();
return *this;
}
/** Postfix increment operator
* \throws Exception::Precondition
*/
BALL_INLINE ConstForwardIterator operator ++ (int)
{
BALL_PRECONDITION_EXCEPTION(Base::isValid(), "cannot increment invalid iterator")
ConstForwardIterator tmp(*this);
++(*this);
return tmp;
}
//@}
protected:
///
BALL_INLINE ConstForwardIterator(const Container& container)
: BaseIterator<Container, DataType, Position, Traits>(container)
{
}
};
//@}
template <typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE
void ConstForwardIterator<Container, DataType, Position, Traits>::toBegin()
{
BALL_PRECONDITION_EXCEPTION(!Base::isSingular(), "cannot move singular iterator to begin")
Base::getTraits().toBegin();
}
template <typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE
ConstForwardIterator<Container, DataType, Position, Traits>
ConstForwardIterator<Container, DataType, Position, Traits>::begin(const Container& container)
{
ConstForwardIterator<Container, DataType, Position, Traits> iterator(container);
iterator.toBegin();
return iterator;
}
template <typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE
bool ConstForwardIterator<Container, DataType, Position, Traits>::isBegin() const
{
if (Base::getTraits().isSingular())
{
return false;
}
return Base::getTraits().isBegin();
}
template <typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE
void ConstForwardIterator<Container, DataType, Position, Traits>::toEnd()
{
BALL_PRECONDITION_EXCEPTION(!Base::isSingular(), "cannot move singular iterator to end")
Base::getTraits().toEnd();
}
template <typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE
ConstForwardIterator<Container, DataType, Position, Traits>
ConstForwardIterator<Container, DataType, Position, Traits>::end(const Container& container)
{
ConstForwardIterator iterator(container);
iterator.toEnd();
return iterator;
}
template <typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE
bool ConstForwardIterator<Container, DataType, Position, Traits>::isEnd() const
{
if (Base::isSingular())
{
return false;
}
return Base::getTraits().isEnd();
}
/** Generic mutable forward iterator class
*/
template <typename Container, typename DataType, typename Position, typename Traits>
class ForwardIterator
: public ConstForwardIterator<Container, DataType, Position, Traits>
{
public:
/** @name Typedefs
*/
//@{
///
typedef DataType& reference;
///
typedef DataType* pointer;
// convenience typedef
typedef ConstForwardIterator<Container, DataType, Position, Traits> Base;
//@}
/** @name Constructors and Destructors
*/
//@{
///
BALL_INLINE ForwardIterator() {}
///
BALL_INLINE ForwardIterator(const ForwardIterator& iterator)
: ConstForwardIterator<Container, DataType, Position, Traits>(iterator)
{
}
///
BALL_INLINE ~ForwardIterator() {}
//@}
/** @name Assignemnt
*/
//@{
///
BALL_INLINE ForwardIterator& operator = (const ForwardIterator& iterator)
{
ConstForwardIterator<Container, DataType, Position, Traits>::operator = (iterator);
return *this;
}
///
BALL_INLINE void swap(ForwardIterator& iterator) { std::swap(Base::getTraits(), iterator.getTraits()); }
//@}
/** @name Iterator methods
*/
//@{
/** Return an iterator pointing to the beginning of the container
* \throws Exception::Precondition
*/
static ForwardIterator begin(const Container& container);
/** Return an iterator pointing at the end of the container
* \throws Exception::Precondition
*/
static ForwardIterator end(const Container& container);
///
BALL_INLINE reference operator * () const
{
return (reference)Base::getTraits().getData();
}
///
BALL_INLINE pointer operator -> () const
{
return (pointer)&Base::getTraits().getData();
}
/** Increment operator
* \throws Exception::Precondition
*/
BALL_INLINE ForwardIterator& operator ++ ()
{
BALL_PRECONDITION_EXCEPTION(Base::isValid(), "cannot increment invalid iterator")
Base::getTraits().forward();
return *this;
}
/** Postfix increment operator
* \throws Exception::Precondition
*/
BALL_INLINE ForwardIterator operator ++ (int)
{
BALL_PRECONDITION_EXCEPTION(Base::isValid(), "cannot increment invalid iterator")
ForwardIterator tmp(*this);
++(*this);
return tmp;
}
//@}
protected:
///
BALL_INLINE ForwardIterator(const Container& container)
: Base(container)
{
}
};
template <typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE
ForwardIterator<Container, DataType, Position, Traits>
ForwardIterator<Container, DataType, Position, Traits>::begin(const Container& container)
{
ForwardIterator iterator(container);
iterator.toBegin();
return iterator;
}
template <typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE
ForwardIterator<Container, DataType, Position, Traits>
ForwardIterator<Container, DataType, Position, Traits>::end(const Container& container)
{
ForwardIterator iterator(container);
iterator.toEnd();
return iterator;
}
} // namespace BALL
#endif // BALL_CONCEPT_FORWARDITERATOR_H
|
