1 /* a generic DYNamic ARray implementation. */
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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_sloppy_inbound_idx(xbt_dynar_t dynar,
40 if (idx > dynar->used) {
41 THROWF(bound_error, idx,
42 "dynar is not that long. You asked %d, but it's only %lu long (could have been equal to it)",
43 (int) (idx), (unsigned long) dynar->used);
47 static XBT_INLINE void _check_populated_dynar(xbt_dynar_t dynar)
49 if (dynar->used == 0) {
50 THROWF(bound_error, 0, "dynar %p is empty", dynar);
55 void _xbt_dynar_resize(xbt_dynar_t dynar, unsigned long new_size)
57 if (new_size != dynar->size) {
58 dynar->size = new_size;
59 dynar->data = xbt_realloc(dynar->data, new_size * dynar->elmsize);
64 void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
66 const unsigned long old_size = dynar->size;
69 const unsigned long expand = 2 * (old_size + 1);
70 _xbt_dynar_resize(dynar, (nb > expand ? nb : expand));
71 XBT_DEBUG("expand %p from %lu to %lu elements",
72 dynar, old_size, dynar->size);
77 void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
79 char *const data = (char *) dynar->data;
80 const unsigned long elmsize = dynar->elmsize;
82 return data + idx * elmsize;
87 _xbt_dynar_get_elm(void *const dst,
88 const xbt_dynar_t dynar, const unsigned long idx)
90 void *const elm = _xbt_dynar_elm(dynar, idx);
92 memcpy(dst, elm, dynar->elmsize);
97 _xbt_dynar_put_elm(const xbt_dynar_t dynar,
98 const unsigned long idx, const void *const src)
100 void *const elm = _xbt_dynar_elm(dynar, idx);
101 const unsigned long elmsize = dynar->elmsize;
103 memcpy(elm, src, elmsize);
106 void xbt_dynar_dump(xbt_dynar_t dynar)
108 XBT_INFO("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
109 dynar->size, dynar->used, dynar->elmsize, dynar->data,
113 /** @brief Constructor
115 * \param elmsize size of each element in the dynar
116 * \param free_f function to call each time we want to get rid of an element (or NULL if nothing to do).
118 * Creates a new dynar. If a free_func is provided, the elements have to be
119 * pointer of pointer. That is to say that dynars can contain either base
120 * types (int, char, double, etc) or pointer of pointers (struct **).
123 xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
126 xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
130 dynar->elmsize = elmsize;
132 dynar->free_f = free_f;
137 /** @brief Destructor of the structure not touching to the content
139 * \param dynar poor victim
141 * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content
142 * is not touched (the \a free_f function is not used)
144 void xbt_dynar_free_container(xbt_dynar_t * dynar)
146 if (dynar && *dynar) {
147 xbt_dynar_t d = *dynar;
154 /** @brief Frees the content and set the size to 0
156 * \param dynar who to squeeze
158 XBT_INLINE void xbt_dynar_reset(xbt_dynar_t const dynar)
160 _sanity_check_dynar(dynar);
162 XBT_DEBUG("Reset the dynar %p", (void *) dynar);
164 xbt_dynar_map(dynar, dynar->free_f);
169 /** @brief Merge dynar d2 into d1
171 * \param d1 dynar to keep
172 * \param d2 dynar to merge into d1. This dynar is free at end.
174 void xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2)
176 if((*d1)->elmsize != (*d2)->elmsize)
177 xbt_die("Element size must are not equal");
179 const unsigned long elmsize = (*d1)->elmsize;
181 void *ptr = _xbt_dynar_elm((*d2), 0);
182 _xbt_dynar_resize(*d1, (*d1)->size + (*d2)->size);
183 void *elm = _xbt_dynar_elm((*d1), (*d1)->used);
185 memcpy(elm, ptr, ((*d2)->size)*elmsize);
186 (*d1)->used += (*d2)->used;
192 * \brief Shrink the dynar by removing empty slots at the end of the internal array
193 * \param dynar a dynar
194 * \param empty_slots_wanted number of empty slots you want to keep at the end of the
195 * internal array for further insertions
197 * Reduces the internal array size of the dynar to the number of elements plus
198 * \a empty_slots_wanted.
199 * After removing elements from the dynar, you can call this function to make
200 * the dynar use less memory.
201 * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much
203 * Note that if \a empty_slots_wanted is greater than the array size, the internal
204 * array is expanded instead of shriked.
206 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
208 _xbt_dynar_resize(dynar, dynar->used + empty_slots_wanted);
211 /** @brief Destructor
213 * \param dynar poor victim
215 * kilkil a dynar and its content
218 XBT_INLINE void xbt_dynar_free(xbt_dynar_t * dynar)
220 if (dynar && *dynar) {
221 xbt_dynar_reset(*dynar);
222 xbt_dynar_free_container(dynar);
226 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
227 void xbt_dynar_free_voidp(void *d)
229 xbt_dynar_t dynar = (xbt_dynar_t)d;
230 xbt_dynar_free(&dynar);
233 /** @brief Count of dynar's elements
235 * \param dynar the dynar we want to mesure
237 XBT_INLINE unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
239 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
242 /**@brief check if a dynar is empty
244 *\param dynar the dynat we want to check
247 XBT_INLINE int xbt_dynar_is_empty(const xbt_dynar_t dynar)
249 return (xbt_dynar_length(dynar) == 0);
252 /** @brief Retrieve a copy of the Nth element of a dynar.
254 * \param dynar information dealer
255 * \param idx index of the slot we want to retrieve
256 * \param[out] dst where to put the result to.
259 xbt_dynar_get_cpy(const xbt_dynar_t dynar,
260 const unsigned long idx, void *const dst)
262 _sanity_check_dynar(dynar);
263 _check_inbound_idx(dynar, idx);
265 _xbt_dynar_get_elm(dst, dynar, idx);
268 /** @brief Retrieve a pointer to the Nth element of a dynar.
270 * \param dynar information dealer
271 * \param idx index of the slot we want to retrieve
272 * \return the \a idx-th element of \a dynar.
274 * \warning The returned value is the actual content of the dynar.
275 * Make a copy before fooling with it.
277 XBT_INLINE void *xbt_dynar_get_ptr(const xbt_dynar_t dynar,
278 const unsigned long idx)
282 _sanity_check_dynar(dynar);
283 _check_inbound_idx(dynar, idx);
285 res = _xbt_dynar_elm(dynar, idx);
289 XBT_INLINE void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
290 const unsigned long idx)
292 _sanity_check_dynar(dynar);
294 if (idx >= dynar->used) {
295 _xbt_dynar_expand(dynar, idx + 1);
296 if (idx > dynar->used) {
297 memset(_xbt_dynar_elm(dynar, dynar->used), 0,
298 (idx - dynar->used) * dynar->elmsize);
300 dynar->used = idx + 1;
302 return _xbt_dynar_elm(dynar, idx);
305 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
307 * \param dynar information dealer
308 * \param idx index of the slot we want to modify
309 * \param src What will be feeded to the dynar
311 * If you want to free the previous content, use xbt_dynar_replace().
313 XBT_INLINE void xbt_dynar_set(xbt_dynar_t dynar, const int idx,
314 const void *const src)
317 memcpy(xbt_dynar_set_at_ptr(dynar, idx), src, dynar->elmsize);
320 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
326 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
327 * free the previous value at this position. If you don't want to free the
328 * previous content, use xbt_dynar_set().
331 xbt_dynar_replace(xbt_dynar_t dynar,
332 const unsigned long idx, const void *const object)
334 _sanity_check_dynar(dynar);
336 if (idx < dynar->used && dynar->free_f) {
337 void *const old_object = _xbt_dynar_elm(dynar, idx);
339 dynar->free_f(old_object);
342 xbt_dynar_set(dynar, idx, object);
345 /** @brief Make room for a new element, and return a pointer to it
347 * You can then use regular affectation to set its value instead of relying
348 * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
350 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
353 unsigned long old_used;
354 unsigned long new_used;
357 _sanity_check_dynar(dynar);
358 _sanity_check_idx(idx);
360 old_used = dynar->used;
361 new_used = old_used + 1;
363 _xbt_dynar_expand(dynar, new_used);
365 nb_shift = old_used - idx;
368 memmove(_xbt_dynar_elm(dynar, idx + 1),
369 _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
372 dynar->used = new_used;
373 res = _xbt_dynar_elm(dynar, idx);
377 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
379 * Set the Nth element of a dynar, expanding the dynar if needed, and
380 * moving the previously existing value and all subsequent ones to one
381 * position right in the dynar.
384 xbt_dynar_insert_at(xbt_dynar_t const dynar,
385 const int idx, const void *const src)
388 /* checks done in xbt_dynar_insert_at_ptr */
389 memcpy(xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
392 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
394 * Get the Nth element of a dynar, removing it from the dynar and moving
395 * all subsequent values to one position left in the dynar.
397 * If the object argument of this function is a non-null pointer, the removed
398 * element is copied to this address. If not, the element is freed using the
399 * free_f function passed at dynar creation.
402 xbt_dynar_remove_at(xbt_dynar_t const dynar,
403 const int idx, void *const object)
405 unsigned long nb_shift;
406 unsigned long offset;
408 _sanity_check_dynar(dynar);
409 _check_inbound_idx(dynar, idx);
412 _xbt_dynar_get_elm(object, dynar, idx);
413 } else if (dynar->free_f) {
414 dynar->free_f(_xbt_dynar_elm(dynar, idx));
417 nb_shift = dynar->used - 1 - idx;
420 offset = nb_shift * dynar->elmsize;
421 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1),
428 /** @brief Remove a slice of the dynar, sliding the rest of the values to the left
430 * This function removes an n-sized slice that starts at element idx. It is equivalent
431 * to xbt_dynar_remove_at with a NULL object argument if n equals to 1.
433 * Each of the removed elements is freed using the free_f function passed at dynar
437 xbt_dynar_remove_n_at(xbt_dynar_t const dynar,
438 const unsigned int n, const int idx)
440 unsigned long nb_shift;
441 unsigned long offset;
446 _sanity_check_dynar(dynar);
447 _check_inbound_idx(dynar, idx);
448 _check_inbound_idx(dynar, idx + n - 1);
451 for (cur = idx; cur < idx + n; cur++) {
452 dynar->free_f(_xbt_dynar_elm(dynar, cur));
456 nb_shift = dynar->used - n - idx;
459 offset = nb_shift * dynar->elmsize;
460 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + n),
467 /** @brief Returns the position of the element in the dynar
469 * Raises not_found_error if not found. If you have less than 2 millions elements,
470 * you probably want to use #xbt_dynar_search_or_negative() instead, so that you
471 * don't have to TRY/CATCH on element not found.
473 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
477 for (it = 0; it < dynar->used; it++)
478 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
482 THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem,
486 /** @brief Returns the position of the element in the dynar (or -1 if not found)
488 * Note that usually, the dynar indices are unsigned integers. If you have more
489 * than 2 million elements in your dynar, this very function will not work (but the other will).
491 signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void *const elem)
495 for (it = 0; it < dynar->used; it++)
496 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
503 /** @brief Returns a boolean indicating whether the element is part of the dynar */
504 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
510 xbt_dynar_search(dynar, elem);
513 if (e.category == not_found_error) {
522 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
524 * You can then use regular affectation to set its value instead of relying
525 * on the slow memcpy. This is what xbt_dynar_push_as() does.
527 XBT_INLINE void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
529 /* we have to inline xbt_dynar_insert_at_ptr here to make sure that
530 dynar->used don't change between reading it and getting the lock
531 within xbt_dynar_insert_at_ptr */
532 return xbt_dynar_insert_at_ptr(dynar, dynar->used);
535 /** @brief Add an element at the end of the dynar */
536 XBT_INLINE void xbt_dynar_push(xbt_dynar_t const dynar,
537 const void *const src)
539 /* checks done in xbt_dynar_insert_at_ptr */
540 memcpy(xbt_dynar_insert_at_ptr(dynar, dynar->used), src,
544 /** @brief Mark the last dynar's element as unused and return a pointer to it.
546 * You can then use regular affectation to set its value instead of relying
547 * on the slow memcpy. This is what xbt_dynar_pop_as() does.
549 XBT_INLINE void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
551 _check_populated_dynar(dynar);
552 XBT_DEBUG("Pop %p", (void *) dynar);
554 return _xbt_dynar_elm(dynar, dynar->used);
557 /** @brief Get and remove the last element of the dynar */
558 XBT_INLINE void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
561 /* sanity checks done by remove_at */
562 XBT_DEBUG("Pop %p", (void *) dynar);
563 xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
566 /** @brief Add an element at the begining of the dynar.
568 * This is less efficient than xbt_dynar_push()
570 XBT_INLINE void xbt_dynar_unshift(xbt_dynar_t const dynar,
571 const void *const src)
574 /* sanity checks done by insert_at */
575 xbt_dynar_insert_at(dynar, 0, src);
578 /** @brief Get and remove the first element of the dynar.
580 * This is less efficient than xbt_dynar_pop()
582 XBT_INLINE void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
585 /* sanity checks done by remove_at */
586 xbt_dynar_remove_at(dynar, 0, dst);
589 /** @brief Apply a function to each member of a dynar
591 * The mapped function may change the value of the element itself,
592 * but should not mess with the structure of the dynar.
594 XBT_INLINE void xbt_dynar_map(const xbt_dynar_t dynar,
595 void_f_pvoid_t const op)
597 char *const data = (char *) dynar->data;
598 const unsigned long elmsize = dynar->elmsize;
599 const unsigned long used = dynar->used;
602 _sanity_check_dynar(dynar);
604 for (i = 0; i < used; i++) {
605 char* elm = (char*) data + i * elmsize;
611 /** @brief Removes and free the entry pointed by the cursor
613 * This function can be used while traversing without problem.
615 XBT_INLINE void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
616 unsigned int *const cursor)
619 xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
622 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
624 * \param dynar the dynar to sort
625 * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
627 * Remark: if the elements stored in the dynar are structures, the compar_fn
628 * function has to retrieve the field to sort first.
630 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar,
631 int_f_cpvoid_cpvoid_t compar_fn)
633 #ifdef HAVE_MERGESORT
634 mergesort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
636 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
640 /** @brief Sorts a dynar according to their color assuming elements can have only three colors.
641 * Since there are only three colors, it is linear and much faster than a classical sort.
642 * See for example http://en.wikipedia.org/wiki/Dutch_national_flag_problem
644 * \param dynar the dynar to sort
645 * \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.
647 * 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.
649 * Remark: if the elements stored in the dynar are structures, the color
650 * function has to retrieve the field to sort first.
652 XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar,
656 unsigned long int p = -1;
657 unsigned long int q = dynar->used;
658 const unsigned long elmsize = dynar->elmsize;
659 void *tmp = xbt_malloc(elmsize);
662 for (i = 0; i < q;) {
663 void *elmi = _xbt_dynar_elm(dynar, i);
664 int colori = color(elmi);
670 elm = _xbt_dynar_elm(dynar, ++p);
672 } else { /* colori == 2 */
673 elm = _xbt_dynar_elm(dynar, --q);
676 memcpy(tmp, elm, elmsize);
677 memcpy(elm, elmi, elmsize);
678 memcpy(elmi, tmp, elmsize);
685 /** @brief Transform a dynar into a NULL terminated array.
686 * The dynar won't be usable afterwards.
687 * \param dynar the dynar to transform
689 XBT_INLINE void * xbt_dynar_to_array (xbt_dynar_t dynar)
692 xbt_dynar_shrink(dynar, 1);
693 memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
700 * Return 0 if d1 and d2 are equal and 1 if not equal
702 XBT_INLINE int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
703 int(*compar)(const void *, const void *))
707 if((!d1) && (!d2)) return 0;
710 XBT_DEBUG("NULL dynar d1=%p d2=%p",d1,d2);
714 if((d1->elmsize)!=(d2->elmsize))
716 XBT_DEBUG("Size of elmsize d1=%lu d2=%lu",d1->elmsize,d2->elmsize);
720 if(xbt_dynar_length(d1) != xbt_dynar_length(d2))
722 XBT_DEBUG("Size of dynar d1=%lu d2=%lu",xbt_dynar_length(d1),xbt_dynar_length(d2));
727 size = xbt_dynar_length(d1);
730 void *data1 = xbt_dynar_get_as(d1, i, void *);
731 void *data2 = xbt_dynar_get_as(d2, i, void *);
732 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
733 if(compar(data1,data2)){
746 XBT_TEST_SUITE("dynar", "Dynar data container");
747 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dyn);
749 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
751 /* Vars_decl [doxygen cruft] */
757 xbt_test_add("==== Traverse the empty dynar");
758 d = xbt_dynar_new(sizeof(int), NULL);
759 xbt_dynar_foreach(d, cursor, i) {
760 xbt_die( "Damnit, there is something in the empty dynar");
762 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
763 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
764 /* in your code is naturally the way to go outside a regression test */
767 ("==== Push %d int, set them again 3 times, traverse them, shift them",
769 /* Populate_ints [doxygen cruft] */
770 /* 1. Populate the dynar */
771 d = xbt_dynar_new(sizeof(int), NULL);
772 for (cpt = 0; cpt < NB_ELEM; cpt++) {
773 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
774 /* xbt_dynar_push(d,&cpt); This would also work */
775 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
778 /* 2. Traverse manually the dynar */
779 for (cursor = 0; cursor < NB_ELEM; cursor++) {
780 iptr = xbt_dynar_get_ptr(d, cursor);
781 xbt_test_assert(cursor == *iptr,
782 "The retrieved value is not the same than the injected one (%u!=%d)",
786 /* 3. Traverse the dynar using the neat macro to that extend */
787 xbt_dynar_foreach(d, cursor, cpt) {
788 xbt_test_assert(cursor == cpt,
789 "The retrieved value is not the same than the injected one (%u!=%d)",
792 /* end_of_traversal */
794 for (cpt = 0; cpt < NB_ELEM; cpt++)
795 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
797 for (cpt = 0; cpt < NB_ELEM; cpt++)
798 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
799 /* xbt_dynar_set(d,cpt,&cpt); */
801 for (cpt = 0; cpt < NB_ELEM; cpt++)
802 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
805 xbt_dynar_foreach(d, cursor, i) {
806 xbt_test_assert(i == cpt,
807 "The retrieved value is not the same than the injected one (%d!=%d)",
811 xbt_test_assert(cpt == NB_ELEM,
812 "Cannot retrieve my %d values. Last got one is %d",
815 /* shifting [doxygen cruft] */
816 /* 4. Shift all the values */
817 for (cpt = 0; cpt < NB_ELEM; cpt++) {
818 xbt_dynar_shift(d, &i);
819 xbt_test_assert(i == cpt,
820 "The retrieved value is not the same than the injected one (%d!=%d)",
822 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
825 /* 5. Free the resources */
826 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
827 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
828 /* in your code is naturally the way to go outside a regression test */
830 xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
831 d = xbt_dynar_new(sizeof(int), NULL);
832 for (cpt = 0; cpt < NB_ELEM; cpt++) {
833 xbt_dynar_unshift(d, &cpt);
834 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
836 for (cpt = 0; cpt < NB_ELEM; cpt++) {
837 i = xbt_dynar_pop_as(d, int);
838 xbt_test_assert(i == cpt,
839 "The retrieved value is not the same than the injected one (%d!=%d)",
841 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
843 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
844 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
845 /* in your code is naturally the way to go outside a regression test */
849 ("==== Push %d int, insert 1000 int in the middle, shift everything",
851 d = xbt_dynar_new(sizeof(int), NULL);
852 for (cpt = 0; cpt < NB_ELEM; cpt++) {
853 xbt_dynar_push_as(d, int, cpt);
854 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
856 for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
857 xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
858 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
861 for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
862 xbt_dynar_shift(d, &i);
863 xbt_test_assert(i == cpt,
864 "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
866 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
868 for (cpt = 999; cpt >= 0; cpt--) {
869 xbt_dynar_shift(d, &i);
870 xbt_test_assert(i == cpt,
871 "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
874 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
875 xbt_dynar_shift(d, &i);
876 xbt_test_assert(i == cpt,
877 "The retrieved value is not the same than the injected one at the end (%d!=%d)",
880 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
881 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
882 /* in your code is naturally the way to go outside a regression test */
884 xbt_test_add("==== Push %d int, remove 2000-4000. free the rest",
886 d = xbt_dynar_new(sizeof(int), NULL);
887 for (cpt = 0; cpt < NB_ELEM; cpt++)
888 xbt_dynar_push_as(d, int, cpt);
890 for (cpt = 2000; cpt < 4000; cpt++) {
891 xbt_dynar_remove_at(d, 2000, &i);
892 xbt_test_assert(i == cpt,
893 "Remove a bad value. Got %d, expected %d", i, cpt);
894 XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
896 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
897 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
898 /* in your code is naturally the way to go outside a regression test */
901 /*******************************************************************************/
902 /*******************************************************************************/
903 /*******************************************************************************/
904 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
906 xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), NULL);
910 xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
911 /* Populate_ints [doxygen cruft] */
912 /* 1. Populate the dynar */
913 for (cpt = 0; cpt < NB_ELEM; cpt++) {
914 xbt_dynar_insert_at(d, cpt, &cpt);
915 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
918 /* 3. Traverse the dynar */
919 xbt_dynar_foreach(d, cursor, cpt) {
920 xbt_test_assert(cursor == cpt,
921 "The retrieved value is not the same than the injected one (%u!=%d)",
924 /* end_of_traversal */
926 /* Re-fill with the same values using set_as (and re-verify) */
927 for (cpt = 0; cpt < NB_ELEM; cpt++)
928 xbt_dynar_set_as(d, cpt, int, cpt);
929 xbt_dynar_foreach(d, cursor, cpt)
930 xbt_test_assert(cursor == cpt,
931 "The retrieved value is not the same than the injected one (%u!=%d)",
934 for (cpt = 0; cpt < NB_ELEM; cpt++) {
936 xbt_dynar_remove_at(d,0,&val);
937 xbt_test_assert(cpt == val,
938 "The retrieved value is not the same than the injected one (%u!=%d)",
941 xbt_test_assert(xbt_dynar_is_empty(d),
942 "There is still %lu elements in the dynar after removing everything",
943 xbt_dynar_length(d));
946 /* ********************* */
947 xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
948 d = xbt_dynar_new(sizeof(int), NULL);
949 for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
950 xbt_dynar_replace(d, cpt, &cpt);
951 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
954 /* 3. Traverse the dynar */
955 xbt_dynar_foreach(d, cursor, cpt) {
956 xbt_test_assert(cursor == cpt,
957 "The retrieved value is not the same than the injected one (%u!=%d)",
960 /* end_of_traversal */
962 for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
964 xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
965 xbt_test_assert(cpt == val,
966 "The retrieved value is not the same than the injected one (%u!=%d)",
969 xbt_test_assert(xbt_dynar_is_empty(d),
970 "There is still %lu elements in the dynar after removing everything",
971 xbt_dynar_length(d));
975 /*******************************************************************************/
976 /*******************************************************************************/
977 /*******************************************************************************/
978 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
985 xbt_test_add("==== Traverse the empty dynar");
986 d = xbt_dynar_new(sizeof(int), NULL);
987 xbt_dynar_foreach(d, cursor, cpt) {
988 xbt_test_assert(FALSE,
989 "Damnit, there is something in the empty dynar");
991 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
992 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
993 /* in your code is naturally the way to go outside a regression test */
995 xbt_test_add("==== Push/shift 5000 doubles");
996 d = xbt_dynar_new(sizeof(double), NULL);
997 for (cpt = 0; cpt < 5000; cpt++) {
999 xbt_dynar_push(d, &d1);
1001 xbt_dynar_foreach(d, cursor, d2) {
1002 d1 = (double) cursor;
1003 xbt_test_assert(d1 == d2,
1004 "The retrieved value is not the same than the injected one (%f!=%f)",
1007 for (cpt = 0; cpt < 5000; cpt++) {
1009 xbt_dynar_shift(d, &d2);
1010 xbt_test_assert(d1 == d2,
1011 "The retrieved value is not the same than the injected one (%f!=%f)",
1014 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1015 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1016 /* in your code is naturally the way to go outside a regression test */
1018 xbt_test_add("==== Unshift/pop 5000 doubles");
1019 d = xbt_dynar_new(sizeof(double), NULL);
1020 for (cpt = 0; cpt < 5000; cpt++) {
1022 xbt_dynar_unshift(d, &d1);
1024 for (cpt = 0; cpt < 5000; cpt++) {
1026 xbt_dynar_pop(d, &d2);
1027 xbt_test_assert(d1 == d2,
1028 "The retrieved value is not the same than the injected one (%f!=%f)",
1031 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1032 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1033 /* in your code is naturally the way to go outside a regression test */
1038 ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
1039 d = xbt_dynar_new(sizeof(double), NULL);
1040 for (cpt = 0; cpt < 5000; cpt++) {
1042 xbt_dynar_push(d, &d1);
1044 for (cpt = 0; cpt < 1000; cpt++) {
1046 xbt_dynar_insert_at(d, 2500, &d1);
1049 for (cpt = 0; cpt < 2500; cpt++) {
1051 xbt_dynar_shift(d, &d2);
1052 xbt_test_assert(d1 == d2,
1053 "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1055 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1057 for (cpt = 999; cpt >= 0; cpt--) {
1059 xbt_dynar_shift(d, &d2);
1060 xbt_test_assert(d1 == d2,
1061 "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1064 for (cpt = 2500; cpt < 5000; cpt++) {
1066 xbt_dynar_shift(d, &d2);
1067 xbt_test_assert(d1 == d2,
1068 "The retrieved value is not the same than the injected one at the end (%f!=%f)",
1071 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1072 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1073 /* in your code is naturally the way to go outside a regression test */
1076 xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1077 d = xbt_dynar_new(sizeof(double), NULL);
1078 for (cpt = 0; cpt < 5000; cpt++) {
1080 xbt_dynar_push(d, &d1);
1082 for (cpt = 2000; cpt < 4000; cpt++) {
1084 xbt_dynar_remove_at(d, 2000, &d2);
1085 xbt_test_assert(d1 == d2,
1086 "Remove a bad value. Got %f, expected %f", d2, d1);
1088 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1089 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1090 /* in your code is naturally the way to go outside a regression test */
1094 /* doxygen_string_cruft */
1096 /*******************************************************************************/
1097 /*******************************************************************************/
1098 /*******************************************************************************/
1099 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1107 xbt_test_add("==== Traverse the empty dynar");
1108 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1109 xbt_dynar_foreach(d, iter, s1) {
1110 xbt_test_assert(FALSE,
1111 "Damnit, there is something in the empty dynar");
1113 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1114 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1115 /* in your code is naturally the way to go outside a regression test */
1117 xbt_test_add("==== Push %d strings, set them again 3 times, shift them",
1119 /* Populate_str [doxygen cruft] */
1120 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1121 /* 1. Populate the dynar */
1122 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1123 sprintf(buf, "%d", cpt);
1125 xbt_dynar_push(d, &s1);
1127 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1128 sprintf(buf, "%d", cpt);
1130 xbt_dynar_replace(d, cpt, &s1);
1132 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1133 sprintf(buf, "%d", cpt);
1135 xbt_dynar_replace(d, cpt, &s1);
1137 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1138 sprintf(buf, "%d", cpt);
1140 xbt_dynar_replace(d, cpt, &s1);
1142 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1143 sprintf(buf, "%d", cpt);
1144 xbt_dynar_shift(d, &s2);
1145 xbt_test_assert(!strcmp(buf, s2),
1146 "The retrieved value is not the same than the injected one (%s!=%s)",
1150 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1151 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1152 /* in your code is naturally the way to go outside a regression test */
1154 xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1155 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1156 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1157 sprintf(buf, "%d", cpt);
1159 xbt_dynar_unshift(d, &s1);
1161 /* 2. Traverse the dynar with the macro */
1162 xbt_dynar_foreach(d, iter, s1) {
1163 sprintf(buf, "%u", NB_ELEM - iter - 1);
1164 xbt_test_assert(!strcmp(buf, s1),
1165 "The retrieved value is not the same than the injected one (%s!=%s)",
1168 /* 3. Traverse the dynar with the macro */
1169 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1170 sprintf(buf, "%d", cpt);
1171 xbt_dynar_pop(d, &s2);
1172 xbt_test_assert(!strcmp(buf, s2),
1173 "The retrieved value is not the same than the injected one (%s!=%s)",
1177 /* 4. Free the resources */
1178 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1179 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1180 /* in your code is naturally the way to go outside a regression test */
1184 ("==== Push %d strings, insert %d strings in the middle, shift everything",
1185 NB_ELEM, NB_ELEM / 5);
1186 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1187 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1188 sprintf(buf, "%d", cpt);
1190 xbt_dynar_push(d, &s1);
1192 for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1193 sprintf(buf, "%d", cpt);
1195 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1198 for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1199 sprintf(buf, "%d", cpt);
1200 xbt_dynar_shift(d, &s2);
1201 xbt_test_assert(!strcmp(buf, s2),
1202 "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1206 for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1207 sprintf(buf, "%d", cpt);
1208 xbt_dynar_shift(d, &s2);
1209 xbt_test_assert(!strcmp(buf, s2),
1210 "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1214 for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1215 sprintf(buf, "%d", cpt);
1216 xbt_dynar_shift(d, &s2);
1217 xbt_test_assert(!strcmp(buf, s2),
1218 "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1222 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1223 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1224 /* in your code is naturally the way to go outside a regression test */
1227 xbt_test_add("==== Push %d strings, remove %d-%d. free the rest",
1228 NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1229 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1230 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1231 sprintf(buf, "%d", cpt);
1233 xbt_dynar_push(d, &s1);
1235 for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1236 sprintf(buf, "%d", cpt);
1237 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1238 xbt_test_assert(!strcmp(buf, s2),
1239 "Remove a bad value. Got %s, expected %s", s2, buf);
1242 xbt_dynar_free(&d); /* end_of_doxygen */
1244 #endif /* SIMGRID_TEST */