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
|
/*
* Copyright (c) International Business Machines Corp., 2014
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*! @file array_iter.h
* @brief Sparse Array Iterator
* @details An array class whose elements are partitioned into data `pages'
* that are allocated upon first-touch.
* @code
* ...
* array_t arr;
* array_init(&arr, sizeof(uint32_t), 1024);
* ...
* array_iter_t it;
* array_iter_init(&it, &arr, VI_FLAG_FWD);
*
* uint32_t * j;
* array_for_each(&it, j) {
* printf("arr[%d] = %d\n", it.idx, *j);
* }
* ...
* @endcode
* @author Shaun Wetzstein <shaun@us.ibm.com>
* @date 2010-2011
*/
#ifndef __ARRAY_ITER_H__
#define __ARRAY_ITER_H__
#include <stdbool.h>
#include <stdint.h>
#include "builtin.h"
#include "array.h"
/* ======================================================================= */
typedef struct array_iter array_iter_t; //!< Alias for the @em array_iter class
/*!
* @brief Array iterator
* @details Array iterator class
*/
struct array_iter {
array_t *array; //!< Reference to the target array object
int32_t idx; //!< Current position of the iterator
uint32_t flags; //!< Iterator configuration flags
};
/* ======================================================================= */
#define AI_FLAG_NONE 0x00000000 //!< No flag mask
#define AI_FLAG_FWD 0x00000000 //!< Forward (FWD) flag mask
#define AI_FLAG_BWD 0x00000002 //!< Backward (BWD) flag mask
#define AI_FLAG_MASK 0x00000003 //!< All flags mask
/*!
* @brief Initializes an @em array_iter iterator object
* @details For example,
* @code
* ...
* array_t ar;
* array_init(&ar, 4, 1024);
* ...
* array_iter_t it;
* array_iter_init(&it, &ar, AI_FLAG_FWD);
* ...
* @endcode
* @memberof array_iter
* @param self [in] array_iter object @em self pointer
* @param array [in] array container object to iterate
* @param flags [in] iterator configuration flags
* @return None
* @throws UNEXPECTED if @em self pointer is NULL
* @throws UNEXPECTED if @em array pointer is NULL
*/
extern void array_iter_init(array_iter_t * self, array_t * array,
uint32_t flags)
/*! @cond */
__nonnull((1, 2)) /*! @endcond */ ;
/*!
* @brief Resets an @em array iterator object
* @details For example,
* @code
* ...
* array_t ar;
* array_init(&ar, 4, 1024);
* ...
* array_iter_t it;
* array_iter_init(&it, &ar, AI_FLAG_FWD);
* array_iter_clear(&it);
* ...
* @endcode
* @memberof array_iter
* @param self [in] array_iter object @em self pointer
* @return None
* @throws UNEXPECTED if @em self pointer is NULL
*/
extern void array_iter_clear(array_iter_t * self)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;
/*!
* @brief Return a pointer to @em array element bytes at the current iterator position
* @details For example,
* @code
* ...
* array_t ar;
* array_init(&ar, 4, 1024);
* ...
* array_iter_t it;
* array_iter_init(&it, &ar, AI_FLAG_FWD);
* ...
* data_t * d = (data_t *)array_iter_elem(&it);
* ...
* @endcode
* @memberof array_iter
* @param self [in] array_iter object @em self pointer
* @throws UNEXPECTED if @em self pointer is NULL
*/
extern const void *array_iter_elem(array_iter_t * self)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;
/*!
* @fn const void * array_iter_inc(array_iter_t * self, size_t count = 1)
* @brief Increment the position of an @em array iterator
* @details If the second (2nd) parameter is omitted, the iterator is incremented by one (1) position.
* @details For example,
* @code
* ...
* array_t ar;
* array_init(&ar, 4, 1024);
* ...
* array_iter_t it;
* array_iter_init(&it, &ar, AI_FLAG_FWD);
* array_iter_inc(&it);
* ...
* @endcode
* @memberof array_iter
* @param self [in] array_iter object @em self pointer
* @param count [in] Number of positions to increment (optional)
* @return None
* @throws UNEXPECTED if @em self pointer is NULL
*/
/*! @cond */
#define array_iter_inc(...) STRCAT(array_iter_inc, NARGS(__VA_ARGS__))(__VA_ARGS__)
extern const void *array_iter_inc1(array_iter_t * self)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;
extern const void *array_iter_inc2(array_iter_t * self, size_t count)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;
/*! @endcond */
/*!
* @fn const void * array_iter_dec(array_iter_t * self, size_t count = 1)
* @brief decrement the position of an @em array iterator
* @note If the second (2nd) parameter is omitted, the iterator is decremented by one (1) position.
* @details For example,
* @code
* ...
* array_t ar;
* array_init(&ar, 4, 1024);
* ...
* array_iter_t it;
* array_iter_init(&it, &ar, AI_FLAG_FWD);
* array_iter_dec(&it, 3);
* ...
* @endcode
* @memberof array_iter
* @param self [in] array_iter object @em self pointer
* @param count [in] Number of positions to decrement (optional)
* @return None
* @throws UNEXPECTED if @em self pointer is NULL
*/
/*! @cond */
#define array_iter_dec(...) STRCAT(array_iter_dec, NARGS(__VA_ARGS__))(__VA_ARGS__)
extern const void *array_iter_dec1(array_iter_t * self)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;
extern const void *array_iter_dec2(array_iter_t * self, size_t count)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;
/*! @endcond */
/*!
* @def array_for_each(it, i)
* @hideinitializer
* @brief Array for-each algorithm
* @param it [in] Tree iterator object
* @param i [in] Tree element variable
*/
#define array_for_each(it, i) \
for (i = (typeof(i))array_iter_elem(it); \
i != NULL; \
i = (typeof(i))array_iter_inc(it, 1))
/* ======================================================================= */
#endif /* __ARRAY_ITER_H__ */
|
