summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension/array.h
blob: e0a0f0859f245a59b4e78987c8fbf9fd9f837ad0 (plain)
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
/*************************************************************************
 * Copyright (C) 2009-2010 Tavian Barnes <tavianator@tavianator.com>     *
 *                                                                       *
 * This file is part of The Dimension Library.                           *
 *                                                                       *
 * The Dimension Library is free software; you can redistribute it and/  *
 * or modify it under the terms of the GNU Lesser General Public License *
 * as published by the Free Software Foundation; either version 3 of the *
 * License, or (at your option) any later version.                       *
 *                                                                       *
 * The Dimension Library 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  *
 * Lesser General Public License for more details.                       *
 *                                                                       *
 * You should have received a copy of the GNU Lesser General Public      *
 * License along with this program.  If not, see                         *
 * <http://www.gnu.org/licenses/>.                                       *
 *************************************************************************/

/**
 * @file
 * Simple dynamic arrays.
 */

#include <stddef.h> /* For size_t */
#include <stdlib.h> /* For qsort() */
#include <string.h> /* For memcpy() */

/** Dynamic array type. */
typedef struct dmnsn_array {
  void *ptr;       /**< @internal The actual memory. */
  size_t obj_size; /**< @internal The size of each object. */
  size_t length;   /**< @internal The current size of the array. */
  size_t capacity; /**< @internal The size of the allocated space. */
} dmnsn_array;

/**
 * Allocate an array.
 * @param[in] obj_size  The size of the objects to store in the array.
 * @return An empty array.
 */
DMNSN_INLINE dmnsn_array *
dmnsn_new_array(size_t obj_size)
{
  dmnsn_array *array = (dmnsn_array *)dmnsn_malloc(sizeof(dmnsn_array));
  array->obj_size = obj_size;
  array->length   = 0;
  array->capacity = 2; /* Start with capacity of 2 */

  /* Allocate the memory */
  array->ptr = dmnsn_malloc(array->capacity*array->obj_size);

  return array;
}

/**
 * Delete an array.
 * @param[in,out] array  The array to delete.
 */
DMNSN_INLINE void
dmnsn_delete_array(dmnsn_array *array)
{
  if (array) {
    dmnsn_free(array->ptr);
    dmnsn_free(array);
  }
}

/**
 * Get the size of the array.
 * @param[in] array  The array in question.
 * @return The number of elements in the array.
 */
DMNSN_INLINE size_t
dmnsn_array_size(const dmnsn_array *array)
{
  return array->length;
}

/**
 * Set the size of the array.
 * @param[in,out] array   The array to resize.
 * @param[in]     length  The new length of the array.
 */
DMNSN_INLINE void
dmnsn_array_resize(dmnsn_array *array, size_t length)
{
  if (length > array->capacity) {
    /* Resize if we don't have enough capacity */
    array->capacity = length*2; /* We are greedy */
    array->ptr = dmnsn_realloc(array->ptr, array->obj_size*array->capacity);
  }

  array->length = length;
}

/**
 * Copy an array.
 * @param[in] array  The array to copy.
 * @return A copy of the array.
 */
DMNSN_INLINE dmnsn_array *
dmnsn_array_copy(const dmnsn_array *array)
{
  dmnsn_array *copy = dmnsn_new_array(array->obj_size);
  dmnsn_array_resize(copy, dmnsn_array_size(array));
  memcpy(copy->ptr, array->ptr, dmnsn_array_size(array)*array->obj_size);
  return copy;
}

/**
 * Split an array in half.
 * @param[in,out] array  The array to split.
 * @return The second half of the array.
 */
DMNSN_INLINE dmnsn_array *
dmnsn_array_split(dmnsn_array *array)
{
  dmnsn_array *half = dmnsn_new_array(array->obj_size);
  size_t new_size = dmnsn_array_size(array)/2;
  size_t old_size = dmnsn_array_size(array) - new_size;
  dmnsn_array_resize(half, new_size);
  memcpy(half->ptr, (char *)array->ptr + old_size*array->obj_size,
         new_size*array->obj_size);
  dmnsn_array_resize(array, old_size);
  return half;
}

/**
 * Get the i'th element.
 * @param[in]  array  The array to access.
 * @param[in]  i      The index of the element to extract.
 * @param[out] obj    The location to store the extracted object.
 */
DMNSN_INLINE void
dmnsn_array_get(const dmnsn_array *array, size_t i, void *obj)
{
  dmnsn_assert(i < dmnsn_array_size(array), "Array index out of bounds.");
  memcpy(obj, (char *)array->ptr + array->obj_size*i, array->obj_size);
}

/**
 * Set the i'th object, expanding the array if necessary.
 * @param[in,out] array  The array to modify.
 * @param[in]     i      The index to update.
 * @param[in]     obj    The location of the object to copy into the array.
 */
DMNSN_INLINE void
dmnsn_array_set(dmnsn_array *array, size_t i, const void *obj)
{
  if (i >= dmnsn_array_size(array)) {
    /* Resize if i is out of range */
    dmnsn_array_resize(array, i + 1);
  }
  memcpy((char *)array->ptr + array->obj_size*i, obj, array->obj_size);
}

/**
 * First element.
 * @param[in] array  The array to index.
 * @return The address of the first element of the array.
 */
DMNSN_INLINE void *
dmnsn_array_first(const dmnsn_array *array)
{
  return array->ptr;
}

/**
 * Last element.
 * @param[in] array  The array to index.
 * @return The address of the last element of the array.
 */
DMNSN_INLINE void *
dmnsn_array_last(const dmnsn_array *array)
{
  return (char *)array->ptr + array->obj_size*(array->length - 1);
}

/**
 * Arbitrary element access.
 * @param[in] array  The array to index.
 * @param[in] i      The index to access.
 * @return The address of the i'th element of the array.
 */
DMNSN_INLINE void *
dmnsn_array_at(const dmnsn_array *array, size_t i)
{
  dmnsn_assert(i < dmnsn_array_size(array), "Array index out of bounds.");
  return (char *)array->ptr + array->obj_size*i;
}

/**
 * Push an object to the end of the array.
 * @param[in,out] array  The array to append to.
 * @param[in]     obj    The location of the object to push.
 */
DMNSN_INLINE void
dmnsn_array_push(dmnsn_array *array, const void *obj)
{
  dmnsn_array_set(array, dmnsn_array_size(array), obj);
}

/**
 * Pop an object from the end of the array.
 * @param[in,out] array  The array to pop from.
 * @param[out]    obj    The location to store the extracted object.
 */
DMNSN_INLINE void
dmnsn_array_pop(dmnsn_array *array, void *obj)
{
  size_t size = dmnsn_array_size(array);
  dmnsn_assert(size > 0, "Array is empty.");
  dmnsn_array_get(array, size - 1, obj); /* Copy the object */
  dmnsn_array_resize(array, size - 1);   /* Shrink the array */
}

/**
 * Insert an item into the middle of the array.  This is O(n).
 * @param[in,out] array  The array to insert to.
 * @param[in]     i      The index at which to insert.
 * @param[in]     obj    The object to insert.
 */
DMNSN_INLINE void
dmnsn_array_insert(dmnsn_array *array, size_t i, const void *obj)
{
  size_t size = dmnsn_array_size(array) + 1;
  if (i >= size)
    size = i + 1;
  dmnsn_array_resize(array, size);

  /* Move the elements at and after `i' 1 to the right */
  memmove((char *)array->ptr + array->obj_size*(i + 1),
          (char *)array->ptr + array->obj_size*i,
          array->obj_size*(size - i - 1));
  /* Insert `obj' at `i' */
  memcpy((char *)array->ptr + array->obj_size*i, obj, array->obj_size);
}

/**
 * Remove an item from the middle of the array.  This is O(n).
 * @param[in,out] array  The array to remove from.
 * @param[in]     i      The index to remove.
 */
DMNSN_INLINE void
dmnsn_array_remove(dmnsn_array *array, size_t i)
{
  size_t size = dmnsn_array_size(array);
  dmnsn_assert(i < size, "Array index out of bounds.");
  /* Move the array elements after `i' 1 to the left */
  memmove((char *)array->ptr + array->obj_size*i,
          (char *)array->ptr + array->obj_size*(i + 1),
          array->obj_size*(size - i - 1));
  /* Decrease the size by 1 */
  dmnsn_array_resize(array, size - 1);
}

/**
 * Apply a callback to each element of an array.
 * @param[in,out] array     The array.
 * @param[in]     callback  The callback to apply to the elements.
 */
DMNSN_INLINE void
dmnsn_array_apply(dmnsn_array *array, dmnsn_callback_fn *callback)
{
  char *i, *last = (char *)dmnsn_array_last(array);
  for (i = (char *)dmnsn_array_first(array); i <= last; i += array->obj_size) {
    callback((void *)i);
  }
}

/**
 * Callback type for array sorting.
 * @param[in] a  The first element.
 * @param[in] b  The second element.
 * @return A negative value iff a < b, zero iff a == b, and a positive value iff
 *         a > b.
 */
typedef int dmnsn_array_comparator_fn(const void *a, const void *b);

/**
 * Sort an array.
 * @param[in,out] array       The array to sort.
 * @param[in]     comparator  The sorting comparator to use.
 */
DMNSN_INLINE void
dmnsn_array_sort(dmnsn_array *array, dmnsn_array_comparator_fn *comparator)
{
  qsort(array->ptr, dmnsn_array_size(array), array->obj_size, comparator);
}

/* Macros to shorten array iteration */

/**
 * Iterate over an array.  For example,
 * @code
 * DMNSN_ARRAY_FOREACH (int *, i, array) {
 *   printf("%d\n", *i);
 * }
 * @endcode
 *
 * @param     type   The (pointer) type to use as an iterator.
 * @param     i      The name of the iterator within the loop body.
 * @param[in] array  The array to loop over.
 */
#define DMNSN_ARRAY_FOREACH(type, i, array)                                    \
  for (type i = dmnsn_array_first(array);                                      \
       (size_t)(i - (type)dmnsn_array_first(array)) < dmnsn_array_size(array); \
       ++i)