1 /* Ordered set data type implemented by an array.
2 Copyright (C) 2006-2007 Free Software Foundation, Inc.
3 Written by Bruno Haible <bruno@clisp.org>, 2006.
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "gl_array_oset.h"
27 /* Checked size_t computations. */
30 /* -------------------------- gl_oset_t Data Type -------------------------- */
32 /* Concrete gl_oset_impl type, valid for this file only. */
35 struct gl_oset_impl_base base;
36 /* An array of ALLOCATED elements, of which the first COUNT are used.
37 0 <= COUNT <= ALLOCATED. */
38 const void **elements;
44 gl_array_create_empty (gl_oset_implementation_t implementation,
45 gl_setelement_compar_fn compar_fn,
46 gl_setelement_dispose_fn dispose_fn)
48 struct gl_oset_impl *set = XMALLOC (struct gl_oset_impl);
50 set->base.vtable = implementation;
51 set->base.compar_fn = compar_fn;
52 set->base.dispose_fn = dispose_fn;
61 gl_array_size (gl_oset_t set)
67 gl_array_indexof (gl_oset_t set, const void *elt)
69 size_t count = set->count;
73 gl_setelement_compar_fn compar = set->base.compar_fn;
77 /* At each loop iteration, low < high; for indices < low the values
78 are smaller than ELT; for indices >= high the values are greater
79 than ELT. So, if the element occurs in the list, it is at
80 low <= position < high. */
83 size_t mid = low + (high - low) / 2; /* low <= mid < high */
84 int cmp = (compar != NULL
85 ? compar (set->elements[mid], elt)
86 : (set->elements[mid] > elt ? 1 :
87 set->elements[mid] < elt ? -1 : 0));
94 /* We have an element equal to ELT at index MID. */
103 gl_array_search (gl_oset_t set, const void *elt)
105 return gl_array_indexof (set, elt) != (size_t)(-1);
109 gl_array_search_atleast (gl_oset_t set,
110 gl_setelement_threshold_fn threshold_fn,
111 const void *threshold,
114 size_t count = set->count;
121 /* At each loop iteration, low < high; for indices < low the values are
122 smaller than THRESHOLD; for indices >= high the values are nonexistent.
123 So, if an element >= THRESHOLD occurs in the list, it is at
124 low <= position < high. */
127 size_t mid = low + (high - low) / 2; /* low <= mid < high */
129 if (! threshold_fn (set->elements[mid], threshold))
133 /* We have an element >= THRESHOLD at index MID. But we need the
134 minimal such index. */
136 /* At each loop iteration, low <= high and
137 compar (list->elements[high], value) >= 0,
138 and we know that the first occurrence of the element is at
139 low <= position <= high. */
142 size_t mid2 = low + (high - low) / 2; /* low <= mid2 < high */
144 if (! threshold_fn (set->elements[mid2], threshold))
149 *eltp = set->elements[low];
158 /* Ensure that set->allocated > set->count. */
162 size_t new_allocated;
166 new_allocated = xtimes (set->allocated, 2);
167 new_allocated = xsum (new_allocated, 1);
168 memory_size = xtimes (new_allocated, sizeof (const void *));
169 if (size_overflow_p (memory_size))
170 /* Overflow, would lead to out of memory. */
172 memory = (const void **) xrealloc (set->elements, memory_size);
176 set->elements = memory;
177 set->allocated = new_allocated;
180 /* Add the given element ELT at the given position,
181 0 <= position <= gl_oset_size (set). */
183 gl_array_add_at (gl_oset_t set, size_t position, const void *elt)
185 size_t count = set->count;
186 const void **elements;
189 if (count == set->allocated)
191 elements = set->elements;
192 for (i = count; i > position; i--)
193 elements[i] = elements[i - 1];
194 elements[position] = elt;
195 set->count = count + 1;
198 /* Remove the element at the given position,
199 0 <= position < gl_oset_size (set). */
201 gl_array_remove_at (gl_oset_t set, size_t position)
203 size_t count = set->count;
204 const void **elements;
207 elements = set->elements;
208 if (set->base.dispose_fn != NULL)
209 set->base.dispose_fn (elements[position]);
210 for (i = position + 1; i < count; i++)
211 elements[i - 1] = elements[i];
212 set->count = count - 1;
216 gl_array_add (gl_oset_t set, const void *elt)
218 size_t count = set->count;
223 gl_setelement_compar_fn compar = set->base.compar_fn;
226 /* At each loop iteration, low < high; for indices < low the values
227 are smaller than ELT; for indices >= high the values are greater
228 than ELT. So, if the element occurs in the list, it is at
229 low <= position < high. */
232 size_t mid = low + (high - low) / 2; /* low <= mid < high */
233 int cmp = (compar != NULL
234 ? compar (set->elements[mid], elt)
235 : (set->elements[mid] > elt ? 1 :
236 set->elements[mid] < elt ? -1 : 0));
247 gl_array_add_at (set, low, elt);
252 gl_array_remove (gl_oset_t set, const void *elt)
254 size_t index = gl_array_indexof (set, elt);
255 if (index != (size_t)(-1))
257 gl_array_remove_at (set, index);
265 gl_array_free (gl_oset_t set)
267 if (set->elements != NULL)
269 if (set->base.dispose_fn != NULL)
271 size_t count = set->count;
275 gl_setelement_dispose_fn dispose = set->base.dispose_fn;
276 const void **elements = set->elements;
279 dispose (*elements++);
283 free (set->elements);
288 /* --------------------- gl_oset_iterator_t Data Type --------------------- */
290 static gl_oset_iterator_t
291 gl_array_iterator (gl_oset_t set)
293 gl_oset_iterator_t result;
295 result.vtable = set->base.vtable;
297 result.count = set->count;
298 result.p = set->elements + 0;
299 result.q = set->elements + set->count;
309 gl_array_iterator_next (gl_oset_iterator_t *iterator, const void **eltp)
311 gl_oset_t set = iterator->set;
312 if (iterator->count != set->count)
314 if (iterator->count != set->count + 1)
315 /* Concurrent modifications were done on the set. */
317 /* The last returned element was removed. */
319 iterator->p = (const void **) iterator->p - 1;
320 iterator->q = (const void **) iterator->q - 1;
322 if (iterator->p < iterator->q)
324 const void **p = (const void **) iterator->p;
334 gl_array_iterator_free (gl_oset_iterator_t *iterator)
339 const struct gl_oset_implementation gl_array_oset_implementation =
341 gl_array_create_empty,
344 gl_array_search_atleast,
349 gl_array_iterator_next,
350 gl_array_iterator_free