1 /* a generic DYNamic ARray implementation. */
3 /* Copyright (c) 2004-2014. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "xbt/sysdep.h"
13 #include "xbt/dynar.h"
14 #include <sys/types.h>
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dyn, xbt, "Dynamic arrays");
18 static XBT_INLINE void _sanity_check_dynar(xbt_dynar_t dynar)
20 xbt_assert(dynar, "dynar is NULL");
23 static XBT_INLINE void _sanity_check_idx(int idx)
25 xbt_assert(idx >= 0, "dynar idx(=%d) < 0", (int) (idx));
28 static XBT_INLINE void _check_inbound_idx(xbt_dynar_t dynar, int idx)
30 if (idx < 0 || idx >= dynar->used) {
31 THROWF(bound_error, idx,
32 "dynar is not that long. You asked %d, but it's only %lu long",
33 (int) (idx), (unsigned long) dynar->used);
37 static XBT_INLINE void _check_populated_dynar(xbt_dynar_t dynar)
39 if (dynar->used == 0) {
40 THROWF(bound_error, 0, "dynar %p is empty", dynar);
45 void _xbt_dynar_resize(xbt_dynar_t dynar, unsigned long new_size)
47 if (new_size != dynar->size) {
48 dynar->size = new_size;
49 dynar->data = xbt_realloc(dynar->data, new_size * dynar->elmsize);
54 void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
56 const unsigned long old_size = dynar->size;
59 const unsigned long expand = 2 * (old_size + 1);
60 _xbt_dynar_resize(dynar, (nb > expand ? nb : expand));
61 XBT_DEBUG("expand %p from %lu to %lu elements",
62 dynar, old_size, dynar->size);
67 void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
69 char *const data = (char *) dynar->data;
70 const unsigned long elmsize = dynar->elmsize;
72 return data + idx * elmsize;
77 _xbt_dynar_get_elm(void *const dst,
78 const xbt_dynar_t dynar, const unsigned long idx)
80 void *const elm = _xbt_dynar_elm(dynar, idx);
82 memcpy(dst, elm, dynar->elmsize);
85 void xbt_dynar_dump(xbt_dynar_t dynar)
87 XBT_INFO("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
88 dynar->size, dynar->used, dynar->elmsize, dynar->data,
92 /** @brief Constructor
94 * \param elmsize size of each element in the dynar
95 * \param free_f function to call each time we want to get rid of an element (or NULL if nothing to do).
97 * Creates a new dynar. If a free_func is provided, the elements have to be
98 * pointer of pointer. That is to say that dynars can contain either base
99 * types (int, char, double, etc) or pointer of pointers (struct **).
102 xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
105 xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
109 dynar->elmsize = elmsize;
111 dynar->free_f = free_f;
116 /** @brief Destructor of the structure not touching to the content
118 * \param dynar poor victim
120 * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content
121 * is not touched (the \a free_f function is not used)
123 void xbt_dynar_free_container(xbt_dynar_t * dynar)
125 if (dynar && *dynar) {
126 xbt_dynar_t d = *dynar;
133 /** @brief Frees the content and set the size to 0
135 * \param dynar who to squeeze
137 XBT_INLINE void xbt_dynar_reset(xbt_dynar_t const dynar)
139 _sanity_check_dynar(dynar);
141 XBT_CDEBUG(xbt_dyn, "Reset the dynar %p", (void *) dynar);
143 xbt_dynar_map(dynar, dynar->free_f);
148 /** @brief Merge dynar d2 into d1
150 * \param d1 dynar to keep
151 * \param d2 dynar to merge into d1. This dynar is free at end.
153 void xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2)
155 if((*d1)->elmsize != (*d2)->elmsize)
156 xbt_die("Element size must are not equal");
158 const unsigned long elmsize = (*d1)->elmsize;
160 void *ptr = _xbt_dynar_elm((*d2), 0);
161 _xbt_dynar_resize(*d1, (*d1)->size + (*d2)->size);
162 void *elm = _xbt_dynar_elm((*d1), (*d1)->used);
164 memcpy(elm, ptr, ((*d2)->size)*elmsize);
165 (*d1)->used += (*d2)->used;
171 * \brief Shrink the dynar by removing empty slots at the end of the internal array
172 * \param dynar a dynar
173 * \param empty_slots_wanted number of empty slots you want to keep at the end of the
174 * internal array for further insertions
176 * Reduces the internal array size of the dynar to the number of elements plus
177 * \a empty_slots_wanted.
178 * After removing elements from the dynar, you can call this function to make
179 * the dynar use less memory.
180 * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much
182 * Note that if \a empty_slots_wanted is greater than the array size, the internal
183 * array is expanded instead of shriked.
185 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
187 _xbt_dynar_resize(dynar, dynar->used + empty_slots_wanted);
190 /** @brief Destructor
192 * \param dynar poor victim
194 * kilkil a dynar and its content
197 XBT_INLINE void xbt_dynar_free(xbt_dynar_t * dynar)
199 if (dynar && *dynar) {
200 xbt_dynar_reset(*dynar);
201 xbt_dynar_free_container(dynar);
205 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
206 void xbt_dynar_free_voidp(void *d)
208 xbt_dynar_t dynar = (xbt_dynar_t)d;
209 xbt_dynar_free(&dynar);
212 /** @brief Count of dynar's elements
214 * \param dynar the dynar we want to mesure
216 XBT_INLINE unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
218 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
221 /**@brief check if a dynar is empty
223 *\param dynar the dynat we want to check
226 XBT_INLINE int xbt_dynar_is_empty(const xbt_dynar_t dynar)
228 return (xbt_dynar_length(dynar) == 0);
231 /** @brief Retrieve a copy of the Nth element of a dynar.
233 * \param dynar information dealer
234 * \param idx index of the slot we want to retrieve
235 * \param[out] dst where to put the result to.
238 xbt_dynar_get_cpy(const xbt_dynar_t dynar,
239 const unsigned long idx, void *const dst)
241 _sanity_check_dynar(dynar);
242 _check_inbound_idx(dynar, idx);
244 _xbt_dynar_get_elm(dst, dynar, idx);
247 /** @brief Retrieve a pointer to the Nth element of a dynar.
249 * \param dynar information dealer
250 * \param idx index of the slot we want to retrieve
251 * \return the \a idx-th element of \a dynar.
253 * \warning The returned value is the actual content of the dynar.
254 * Make a copy before fooling with it.
256 XBT_INLINE void *xbt_dynar_get_ptr(const xbt_dynar_t dynar,
257 const unsigned long idx)
261 _sanity_check_dynar(dynar);
262 _check_inbound_idx(dynar, idx);
264 res = _xbt_dynar_elm(dynar, idx);
268 XBT_INLINE void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
269 const unsigned long idx)
271 _sanity_check_dynar(dynar);
273 if (idx >= dynar->used) {
274 _xbt_dynar_expand(dynar, idx + 1);
275 if (idx > dynar->used) {
276 memset(_xbt_dynar_elm(dynar, dynar->used), 0,
277 (idx - dynar->used) * dynar->elmsize);
279 dynar->used = idx + 1;
281 return _xbt_dynar_elm(dynar, idx);
284 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
286 * \param dynar information dealer
287 * \param idx index of the slot we want to modify
288 * \param src What will be feeded to the dynar
290 * If you want to free the previous content, use xbt_dynar_replace().
292 XBT_INLINE void xbt_dynar_set(xbt_dynar_t dynar, const int idx,
293 const void *const src)
296 memcpy(xbt_dynar_set_at_ptr(dynar, idx), src, dynar->elmsize);
299 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
305 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
306 * free the previous value at this position. If you don't want to free the
307 * previous content, use xbt_dynar_set().
310 xbt_dynar_replace(xbt_dynar_t dynar,
311 const unsigned long idx, const void *const object)
313 _sanity_check_dynar(dynar);
315 if (idx < dynar->used && dynar->free_f) {
316 void *const old_object = _xbt_dynar_elm(dynar, idx);
318 dynar->free_f(old_object);
321 xbt_dynar_set(dynar, idx, object);
324 /** @brief Make room for a new element, and return a pointer to it
326 * You can then use regular affectation to set its value instead of relying
327 * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
329 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
332 unsigned long old_used;
333 unsigned long new_used;
336 _sanity_check_dynar(dynar);
337 _sanity_check_idx(idx);
339 old_used = dynar->used;
340 new_used = old_used + 1;
342 _xbt_dynar_expand(dynar, new_used);
344 nb_shift = old_used - idx;
347 memmove(_xbt_dynar_elm(dynar, idx + 1),
348 _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
351 dynar->used = new_used;
352 res = _xbt_dynar_elm(dynar, idx);
356 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
358 * Set the Nth element of a dynar, expanding the dynar if needed, and
359 * moving the previously existing value and all subsequent ones to one
360 * position right in the dynar.
363 xbt_dynar_insert_at(xbt_dynar_t const dynar,
364 const int idx, const void *const src)
367 /* checks done in xbt_dynar_insert_at_ptr */
368 memcpy(xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
371 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
373 * Get the Nth element of a dynar, removing it from the dynar and moving
374 * all subsequent values to one position left in the dynar.
376 * If the object argument of this function is a non-null pointer, the removed
377 * element is copied to this address. If not, the element is freed using the
378 * free_f function passed at dynar creation.
381 xbt_dynar_remove_at(xbt_dynar_t const dynar,
382 const int idx, void *const object)
384 unsigned long nb_shift;
385 unsigned long offset;
387 _sanity_check_dynar(dynar);
388 _check_inbound_idx(dynar, idx);
391 _xbt_dynar_get_elm(object, dynar, idx);
392 } else if (dynar->free_f) {
393 dynar->free_f(_xbt_dynar_elm(dynar, idx));
396 nb_shift = dynar->used - 1 - idx;
399 offset = nb_shift * dynar->elmsize;
400 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1),
407 /** @brief Remove a slice of the dynar, sliding the rest of the values to the left
409 * This function removes an n-sized slice that starts at element idx. It is equivalent
410 * to xbt_dynar_remove_at with a NULL object argument if n equals to 1.
412 * Each of the removed elements is freed using the free_f function passed at dynar
416 xbt_dynar_remove_n_at(xbt_dynar_t const dynar,
417 const unsigned int n, const int idx)
419 unsigned long nb_shift;
420 unsigned long offset;
425 _sanity_check_dynar(dynar);
426 _check_inbound_idx(dynar, idx);
427 _check_inbound_idx(dynar, idx + n - 1);
430 for (cur = idx; cur < idx + n; cur++) {
431 dynar->free_f(_xbt_dynar_elm(dynar, cur));
435 nb_shift = dynar->used - n - idx;
438 offset = nb_shift * dynar->elmsize;
439 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + n),
446 /** @brief Returns the position of the element in the dynar
448 * Beware that if your dynar contains pointed values (such as strings) instead
449 * of scalar, this function compares the pointer value, not what's pointed. The only
450 * solution to search for a pointed value is then to write the foreach loop yourself:
452 * signed int position = -1;
453 * xbt_dynar_foreach(dynar, iter, elem) {
454 * if (!memcmp(elem, searched_element, sizeof(*elem))) {
461 * Raises not_found_error if not found. If you have less than 2 millions elements,
462 * you probably want to use #xbt_dynar_search_or_negative() instead, so that you
463 * don't have to TRY/CATCH on element not found.
465 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
469 for (it = 0; it < dynar->used; it++)
470 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
474 THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem,
478 /** @brief Returns the position of the element in the dynar (or -1 if not found)
480 * Beware that if your dynar contains pointed values (such as
481 * strings) instead of scalar, this function is probably not what you
482 * want. Check the documentation of xbt_dynar_search() for more info.
484 * Note that usually, the dynar indices are unsigned integers. If you have more
485 * than 2 million elements in your dynar, this very function will not work (but the other will).
487 signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void *const elem)
491 for (it = 0; it < dynar->used; it++)
492 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
499 /** @brief Returns a boolean indicating whether the element is part of the dynar
501 * Beware that if your dynar contains pointed values (such as
502 * strings) instead of scalar, this function is probably not what you
503 * want. Check the documentation of xbt_dynar_search() for more info.
505 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
511 xbt_dynar_search(dynar, elem);
514 if (e.category == not_found_error) {
523 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
525 * You can then use regular affectation to set its value instead of relying
526 * on the slow memcpy. This is what xbt_dynar_push_as() does.
528 XBT_INLINE void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
530 return xbt_dynar_insert_at_ptr(dynar, dynar->used);
533 /** @brief Add an element at the end of the dynar */
534 XBT_INLINE void xbt_dynar_push(xbt_dynar_t const dynar,
535 const void *const src)
537 /* checks done in xbt_dynar_insert_at_ptr */
538 memcpy(xbt_dynar_insert_at_ptr(dynar, dynar->used), src, dynar->elmsize);
541 /** @brief Mark the last dynar's element as unused and return a pointer to it.
543 * You can then use regular affectation to set its value instead of relying
544 * on the slow memcpy. This is what xbt_dynar_pop_as() does.
546 XBT_INLINE void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
548 _check_populated_dynar(dynar);
549 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
551 return _xbt_dynar_elm(dynar, dynar->used);
554 /** @brief Get and remove the last element of the dynar */
555 XBT_INLINE void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
558 /* sanity checks done by remove_at */
559 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
560 xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
563 /** @brief Add an element at the begining of the dynar.
565 * This is less efficient than xbt_dynar_push()
567 XBT_INLINE void xbt_dynar_unshift(xbt_dynar_t const dynar,
568 const void *const src)
571 /* sanity checks done by insert_at */
572 xbt_dynar_insert_at(dynar, 0, src);
575 /** @brief Get and remove the first element of the dynar.
577 * This is less efficient than xbt_dynar_pop()
579 XBT_INLINE void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
582 /* sanity checks done by remove_at */
583 xbt_dynar_remove_at(dynar, 0, dst);
586 /** @brief Apply a function to each member of a dynar
588 * The mapped function may change the value of the element itself,
589 * but should not mess with the structure of the dynar.
591 XBT_INLINE void xbt_dynar_map(const xbt_dynar_t dynar,
592 void_f_pvoid_t const op)
594 char *const data = (char *) dynar->data;
595 const unsigned long elmsize = dynar->elmsize;
596 const unsigned long used = dynar->used;
599 _sanity_check_dynar(dynar);
601 for (i = 0; i < used; i++) {
602 char* elm = (char*) data + i * elmsize;
608 /** @brief Removes and free the entry pointed by the cursor
610 * This function can be used while traversing without problem.
612 XBT_INLINE void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
613 unsigned int *const cursor)
616 xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
619 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
621 * \param dynar the dynar to sort
622 * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
624 * Remark: if the elements stored in the dynar are structures, the compar_fn
625 * function has to retrieve the field to sort first.
627 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar,
628 int_f_cpvoid_cpvoid_t compar_fn)
630 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
633 /** @brief Sorts a dynar according to their color assuming elements can have only three colors.
634 * Since there are only three colors, it is linear and much faster than a classical sort.
635 * See for example http://en.wikipedia.org/wiki/Dutch_national_flag_problem
637 * \param dynar the dynar to sort
638 * \param color the color function of type (int (compar_fn*) (void*) (void*)). The return value of color is assumed to be 0, 1, or 2.
640 * At the end of the call, elements with color 0 are at the beginning of the dynar, elements with color 2 are at the end and elements with color 1 are in the middle.
642 * Remark: if the elements stored in the dynar are structures, the color
643 * function has to retrieve the field to sort first.
645 XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar,
649 unsigned long int p = -1;
650 unsigned long int q = dynar->used;
651 const unsigned long elmsize = dynar->elmsize;
652 void *tmp = xbt_malloc(elmsize);
655 for (i = 0; i < q;) {
656 void *elmi = _xbt_dynar_elm(dynar, i);
657 int colori = color(elmi);
663 elm = _xbt_dynar_elm(dynar, ++p);
665 } else { /* colori == 2 */
666 elm = _xbt_dynar_elm(dynar, --q);
669 memcpy(tmp, elm, elmsize);
670 memcpy(elm, elmi, elmsize);
671 memcpy(elmi, tmp, elmsize);
678 /** @brief Transform a dynar into a NULL terminated array.
680 * \param dynar the dynar to transform
681 * \return pointer to the first element of the array
683 * Note: The dynar won't be usable afterwards.
685 XBT_INLINE void *xbt_dynar_to_array(xbt_dynar_t dynar)
688 xbt_dynar_shrink(dynar, 1);
689 memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
695 /** @brief Compare two dynars
697 * \param d1 first dynar to compare
698 * \param d2 second dynar to compare
699 * \param compar function to use to compare elements
700 * \return 0 if d1 and d2 are equal and 1 if not equal
702 * d1 and d2 should be dynars of pointers. The compar function takes two
703 * elements and returns 0 when they are considered equal, and a value different
704 * of zero when they are considered different. Finally, d2 is destroyed
707 int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
708 int(*compar)(const void *, const void *))
712 if((!d1) && (!d2)) return 0;
715 XBT_DEBUG("NULL dynar d1=%p d2=%p",d1,d2);
719 if((d1->elmsize)!=(d2->elmsize))
721 XBT_DEBUG("Size of elmsize d1=%lu d2=%lu",d1->elmsize,d2->elmsize);
725 if(xbt_dynar_length(d1) != xbt_dynar_length(d2))
727 XBT_DEBUG("Size of dynar d1=%lu d2=%lu",xbt_dynar_length(d1),xbt_dynar_length(d2));
732 size = xbt_dynar_length(d1);
735 void *data1 = xbt_dynar_get_as(d1, i, void *);
736 void *data2 = xbt_dynar_get_as(d2, i, void *);
737 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
738 if(compar(data1,data2)){
751 XBT_TEST_SUITE("dynar", "Dynar data container");
752 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dyn);
754 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
756 /* Vars_decl [doxygen cruft] */
762 xbt_test_add("==== Traverse the empty dynar");
763 d = xbt_dynar_new(sizeof(int), NULL);
764 xbt_dynar_foreach(d, cursor, i) {
765 xbt_die( "Damnit, there is something in the empty dynar");
767 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
768 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
769 /* in your code is naturally the way to go outside a regression test */
772 ("==== Push %d int, set them again 3 times, traverse them, shift them",
774 /* Populate_ints [doxygen cruft] */
775 /* 1. Populate the dynar */
776 d = xbt_dynar_new(sizeof(int), NULL);
777 for (cpt = 0; cpt < NB_ELEM; cpt++) {
778 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
779 /* xbt_dynar_push(d,&cpt); This would also work */
780 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
783 /* 2. Traverse manually the dynar */
784 for (cursor = 0; cursor < NB_ELEM; cursor++) {
785 iptr = xbt_dynar_get_ptr(d, cursor);
786 xbt_test_assert(cursor == *iptr,
787 "The retrieved value is not the same than the injected one (%u!=%d)",
791 /* 3. Traverse the dynar using the neat macro to that extend */
792 xbt_dynar_foreach(d, cursor, cpt) {
793 xbt_test_assert(cursor == cpt,
794 "The retrieved value is not the same than the injected one (%u!=%d)",
797 /* end_of_traversal */
799 for (cpt = 0; cpt < NB_ELEM; cpt++)
800 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
802 for (cpt = 0; cpt < NB_ELEM; cpt++)
803 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
804 /* xbt_dynar_set(d,cpt,&cpt); */
806 for (cpt = 0; cpt < NB_ELEM; cpt++)
807 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
810 xbt_dynar_foreach(d, cursor, i) {
811 xbt_test_assert(i == cpt,
812 "The retrieved value is not the same than the injected one (%d!=%d)",
816 xbt_test_assert(cpt == NB_ELEM,
817 "Cannot retrieve my %d values. Last got one is %d",
820 /* shifting [doxygen cruft] */
821 /* 4. Shift all the values */
822 for (cpt = 0; cpt < NB_ELEM; cpt++) {
823 xbt_dynar_shift(d, &i);
824 xbt_test_assert(i == cpt,
825 "The retrieved value is not the same than the injected one (%d!=%d)",
827 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
831 xbt_dynar_foreach_ptr(d, cursor, pi) {
834 xbt_dynar_foreach(d, cursor, i) {
835 xbt_test_assert(i == 0, "The value is not the same as the expected one.");
837 xbt_dynar_foreach_ptr(d, cursor, pi) {
840 xbt_dynar_foreach(d, cursor, i) {
841 xbt_test_assert(i == 1, "The value is not the same as the expected one.");
844 /* 5. Free the resources */
845 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
846 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
847 /* in your code is naturally the way to go outside a regression test */
849 xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
850 d = xbt_dynar_new(sizeof(int), NULL);
851 for (cpt = 0; cpt < NB_ELEM; cpt++) {
852 xbt_dynar_unshift(d, &cpt);
853 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
855 for (cpt = 0; cpt < NB_ELEM; cpt++) {
856 i = xbt_dynar_pop_as(d, int);
857 xbt_test_assert(i == cpt,
858 "The retrieved value is not the same than the injected one (%d!=%d)",
860 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
862 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
863 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
864 /* in your code is naturally the way to go outside a regression test */
868 ("==== Push %d int, insert 1000 int in the middle, shift everything",
870 d = xbt_dynar_new(sizeof(int), NULL);
871 for (cpt = 0; cpt < NB_ELEM; cpt++) {
872 xbt_dynar_push_as(d, int, cpt);
873 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
875 for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
876 xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
877 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
880 for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
881 xbt_dynar_shift(d, &i);
882 xbt_test_assert(i == cpt,
883 "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
885 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
887 for (cpt = 999; cpt >= 0; cpt--) {
888 xbt_dynar_shift(d, &i);
889 xbt_test_assert(i == cpt,
890 "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
893 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
894 xbt_dynar_shift(d, &i);
895 xbt_test_assert(i == cpt,
896 "The retrieved value is not the same than the injected one at the end (%d!=%d)",
899 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
900 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
901 /* in your code is naturally the way to go outside a regression test */
903 xbt_test_add("==== Push %d int, remove 2000-4000. free the rest",
905 d = xbt_dynar_new(sizeof(int), NULL);
906 for (cpt = 0; cpt < NB_ELEM; cpt++)
907 xbt_dynar_push_as(d, int, cpt);
909 for (cpt = 2000; cpt < 4000; cpt++) {
910 xbt_dynar_remove_at(d, 2000, &i);
911 xbt_test_assert(i == cpt,
912 "Remove a bad value. Got %d, expected %d", i, cpt);
913 XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
915 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
916 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
917 /* in your code is naturally the way to go outside a regression test */
920 /*******************************************************************************/
921 /*******************************************************************************/
922 /*******************************************************************************/
923 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
925 xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), NULL);
929 xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
930 /* Populate_ints [doxygen cruft] */
931 /* 1. Populate the dynar */
932 for (cpt = 0; cpt < NB_ELEM; cpt++) {
933 xbt_dynar_insert_at(d, cpt, &cpt);
934 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
937 /* 3. Traverse the dynar */
938 xbt_dynar_foreach(d, cursor, cpt) {
939 xbt_test_assert(cursor == cpt,
940 "The retrieved value is not the same than the injected one (%u!=%d)",
943 /* end_of_traversal */
945 /* Re-fill with the same values using set_as (and re-verify) */
946 for (cpt = 0; cpt < NB_ELEM; cpt++)
947 xbt_dynar_set_as(d, cpt, int, cpt);
948 xbt_dynar_foreach(d, cursor, cpt)
949 xbt_test_assert(cursor == cpt,
950 "The retrieved value is not the same than the injected one (%u!=%d)",
953 for (cpt = 0; cpt < NB_ELEM; cpt++) {
955 xbt_dynar_remove_at(d,0,&val);
956 xbt_test_assert(cpt == val,
957 "The retrieved value is not the same than the injected one (%u!=%d)",
960 xbt_test_assert(xbt_dynar_is_empty(d),
961 "There is still %lu elements in the dynar after removing everything",
962 xbt_dynar_length(d));
965 /* ********************* */
966 xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
967 d = xbt_dynar_new(sizeof(int), NULL);
968 for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
969 xbt_dynar_replace(d, cpt, &cpt);
970 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
973 /* 3. Traverse the dynar */
974 xbt_dynar_foreach(d, cursor, cpt) {
975 xbt_test_assert(cursor == cpt,
976 "The retrieved value is not the same than the injected one (%u!=%d)",
979 /* end_of_traversal */
981 for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
983 xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
984 xbt_test_assert(cpt == val,
985 "The retrieved value is not the same than the injected one (%u!=%d)",
988 xbt_test_assert(xbt_dynar_is_empty(d),
989 "There is still %lu elements in the dynar after removing everything",
990 xbt_dynar_length(d));
994 /*******************************************************************************/
995 /*******************************************************************************/
996 /*******************************************************************************/
997 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
1001 unsigned int cursor;
1004 xbt_test_add("==== Traverse the empty dynar");
1005 d = xbt_dynar_new(sizeof(int), NULL);
1006 xbt_dynar_foreach(d, cursor, cpt) {
1007 xbt_test_assert(FALSE,
1008 "Damnit, there is something in the empty dynar");
1010 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1011 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1012 /* in your code is naturally the way to go outside a regression test */
1014 xbt_test_add("==== Push/shift 5000 doubles");
1015 d = xbt_dynar_new(sizeof(double), NULL);
1016 for (cpt = 0; cpt < 5000; cpt++) {
1018 xbt_dynar_push(d, &d1);
1020 xbt_dynar_foreach(d, cursor, d2) {
1021 d1 = (double) cursor;
1022 xbt_test_assert(d1 == d2,
1023 "The retrieved value is not the same than the injected one (%f!=%f)",
1026 for (cpt = 0; cpt < 5000; cpt++) {
1028 xbt_dynar_shift(d, &d2);
1029 xbt_test_assert(d1 == d2,
1030 "The retrieved value is not the same than the injected one (%f!=%f)",
1033 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1034 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1035 /* in your code is naturally the way to go outside a regression test */
1037 xbt_test_add("==== Unshift/pop 5000 doubles");
1038 d = xbt_dynar_new(sizeof(double), NULL);
1039 for (cpt = 0; cpt < 5000; cpt++) {
1041 xbt_dynar_unshift(d, &d1);
1043 for (cpt = 0; cpt < 5000; cpt++) {
1045 xbt_dynar_pop(d, &d2);
1046 xbt_test_assert(d1 == d2,
1047 "The retrieved value is not the same than the injected one (%f!=%f)",
1050 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1051 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1052 /* in your code is naturally the way to go outside a regression test */
1057 ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
1058 d = xbt_dynar_new(sizeof(double), NULL);
1059 for (cpt = 0; cpt < 5000; cpt++) {
1061 xbt_dynar_push(d, &d1);
1063 for (cpt = 0; cpt < 1000; cpt++) {
1065 xbt_dynar_insert_at(d, 2500, &d1);
1068 for (cpt = 0; cpt < 2500; cpt++) {
1070 xbt_dynar_shift(d, &d2);
1071 xbt_test_assert(d1 == d2,
1072 "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1074 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1076 for (cpt = 999; cpt >= 0; cpt--) {
1078 xbt_dynar_shift(d, &d2);
1079 xbt_test_assert(d1 == d2,
1080 "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1083 for (cpt = 2500; cpt < 5000; cpt++) {
1085 xbt_dynar_shift(d, &d2);
1086 xbt_test_assert(d1 == d2,
1087 "The retrieved value is not the same than the injected one at the end (%f!=%f)",
1090 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1091 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1092 /* in your code is naturally the way to go outside a regression test */
1095 xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1096 d = xbt_dynar_new(sizeof(double), NULL);
1097 for (cpt = 0; cpt < 5000; cpt++) {
1099 xbt_dynar_push(d, &d1);
1101 for (cpt = 2000; cpt < 4000; cpt++) {
1103 xbt_dynar_remove_at(d, 2000, &d2);
1104 xbt_test_assert(d1 == d2,
1105 "Remove a bad value. Got %f, expected %f", d2, d1);
1107 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1108 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1109 /* in your code is naturally the way to go outside a regression test */
1113 /* doxygen_string_cruft */
1115 /*******************************************************************************/
1116 /*******************************************************************************/
1117 /*******************************************************************************/
1118 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1126 xbt_test_add("==== Traverse the empty dynar");
1127 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1128 xbt_dynar_foreach(d, iter, s1) {
1129 xbt_test_assert(FALSE,
1130 "Damnit, there is something in the empty dynar");
1132 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1133 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1134 /* in your code is naturally the way to go outside a regression test */
1136 xbt_test_add("==== Push %d strings, set them again 3 times, shift them",
1138 /* Populate_str [doxygen cruft] */
1139 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1140 /* 1. Populate the dynar */
1141 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1142 sprintf(buf, "%d", cpt);
1143 s1 = xbt_strdup(buf);
1144 xbt_dynar_push(d, &s1);
1146 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1147 sprintf(buf, "%d", cpt);
1148 s1 = xbt_strdup(buf);
1149 xbt_dynar_replace(d, cpt, &s1);
1151 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1152 sprintf(buf, "%d", cpt);
1153 s1 = xbt_strdup(buf);
1154 xbt_dynar_replace(d, cpt, &s1);
1156 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1157 sprintf(buf, "%d", cpt);
1158 s1 = xbt_strdup(buf);
1159 xbt_dynar_replace(d, cpt, &s1);
1161 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1162 sprintf(buf, "%d", cpt);
1163 xbt_dynar_shift(d, &s2);
1164 xbt_test_assert(!strcmp(buf, s2),
1165 "The retrieved value is not the same than the injected one (%s!=%s)",
1169 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1170 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1171 /* in your code is naturally the way to go outside a regression test */
1173 xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1174 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1175 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1176 sprintf(buf, "%d", cpt);
1177 s1 = xbt_strdup(buf);
1178 xbt_dynar_unshift(d, &s1);
1180 /* 2. Traverse the dynar with the macro */
1181 xbt_dynar_foreach(d, iter, s1) {
1182 sprintf(buf, "%u", NB_ELEM - iter - 1);
1183 xbt_test_assert(!strcmp(buf, s1),
1184 "The retrieved value is not the same than the injected one (%s!=%s)",
1187 /* 3. Traverse the dynar with the macro */
1188 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1189 sprintf(buf, "%d", cpt);
1190 xbt_dynar_pop(d, &s2);
1191 xbt_test_assert(!strcmp(buf, s2),
1192 "The retrieved value is not the same than the injected one (%s!=%s)",
1196 /* 4. Free the resources */
1197 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1198 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1199 /* in your code is naturally the way to go outside a regression test */
1203 ("==== Push %d strings, insert %d strings in the middle, shift everything",
1204 NB_ELEM, NB_ELEM / 5);
1205 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1206 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1207 sprintf(buf, "%d", cpt);
1208 s1 = xbt_strdup(buf);
1209 xbt_dynar_push(d, &s1);
1211 for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1212 sprintf(buf, "%d", cpt);
1213 s1 = xbt_strdup(buf);
1214 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1217 for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1218 sprintf(buf, "%d", cpt);
1219 xbt_dynar_shift(d, &s2);
1220 xbt_test_assert(!strcmp(buf, s2),
1221 "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1225 for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1226 sprintf(buf, "%d", cpt);
1227 xbt_dynar_shift(d, &s2);
1228 xbt_test_assert(!strcmp(buf, s2),
1229 "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1233 for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1234 sprintf(buf, "%d", cpt);
1235 xbt_dynar_shift(d, &s2);
1236 xbt_test_assert(!strcmp(buf, s2),
1237 "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1241 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1242 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1243 /* in your code is naturally the way to go outside a regression test */
1246 xbt_test_add("==== Push %d strings, remove %d-%d. free the rest",
1247 NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1248 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1249 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1250 sprintf(buf, "%d", cpt);
1251 s1 = xbt_strdup(buf);
1252 xbt_dynar_push(d, &s1);
1254 for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1255 sprintf(buf, "%d", cpt);
1256 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1257 xbt_test_assert(!strcmp(buf, s2),
1258 "Remove a bad value. Got %s, expected %s", s2, buf);
1261 xbt_dynar_free(&d); /* end_of_doxygen */
1263 #endif /* SIMGRID_TEST */