Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add a new function xbt_dynar_sort() which is a wrapper on qsort.
[simgrid.git] / src / xbt / dynar.c
index 906434b..5498ba1 100644 (file)
@@ -1,8 +1,7 @@
-/* $Id$ */
-
 /* a generic DYNamic ARray implementation.                                  */
 
-/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -171,9 +170,11 @@ _xbt_dynar_remove_at(xbt_dynar_t const dynar,
   }
 
   nb_shift = dynar->used - 1 - idx;
-  offset = nb_shift * dynar->elmsize;
 
-  memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1), offset);
+  if (nb_shift) {
+    offset = nb_shift * dynar->elmsize;
+    memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1), offset);
+  }
 
   dynar->used--;
 }
@@ -288,7 +289,7 @@ XBT_INLINE void xbt_dynar_reset(xbt_dynar_t const dynar)
  * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much
  * as possible.
  * Note that if \a empty_slots_wanted is greater than the array size, the internal
- * array is not expanded and nothing is done.
+ * array is expanded instead of shriked.
  */
 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
 {
@@ -297,9 +298,9 @@ void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
   _dynar_lock(dynar);
 
   size_wanted = dynar->used + empty_slots_wanted;
-  if (size_wanted < dynar->size) {
+  if (size_wanted != dynar->size) {
     dynar->size = size_wanted;
-    dynar->data = xbt_realloc(dynar->data, sizeof(void *) * dynar->size);
+    dynar->data = xbt_realloc(dynar->data, dynar->elmsize * dynar->size);
   }
   _dynar_unlock(dynar);
 }
@@ -684,6 +685,22 @@ XBT_INLINE void xbt_dynar_cursor_unlock(xbt_dynar_t dynar)
   _dynar_unlock(dynar);
 }
 
+/** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
+ *
+ * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
+ *
+ * Remark: if the elements stored in the dynar are structures, the compar_fn
+ * function has to retrieve the field to sort first.
+ */
+XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar, int_f_pvoid_pvoid_t compar_fn){
+
+       _dynar_lock(dynar);
+
+       qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
+
+       _dynar_unlock(dynar);
+}
+
 #ifdef SIMGRID_TEST
 
 #define NB_ELEM 5000
@@ -705,8 +722,9 @@ XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
   xbt_dynar_foreach(d, cursor, i) {
     xbt_assert0(0, "Damnit, there is something in the empty dynar");
   }
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 
   xbt_test_add1
     ("==== Push %d int, set them again 3 times, traverse them, shift them",
@@ -768,9 +786,9 @@ XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
   }
 
   /* 5. Free the resources */
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
-
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 
   xbt_test_add1("==== Unshift/pop %d int", NB_ELEM);
   d = xbt_dynar_new(sizeof(int), NULL);
@@ -785,8 +803,9 @@ XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
                      i, cpt);
     xbt_test_log2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
   }
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 
 
   xbt_test_add1
@@ -821,9 +840,9 @@ XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
                      "The retrieved value is not the same than the injected one at the end (%d!=%d)",
                      i, cpt);
   }
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
-
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 
   xbt_test_add1("==== Push %d int, remove 2000-4000. free the rest", NB_ELEM);
   d = xbt_dynar_new(sizeof(int), NULL);
@@ -836,8 +855,9 @@ XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
                      "Remove a bad value. Got %d, expected %d", i, cpt);
     DEBUG2("remove %d, length=%lu", cpt, xbt_dynar_length(d));
   }
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 }
 
 /*******************************************************************************/
@@ -855,8 +875,9 @@ XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
   xbt_dynar_foreach(d, cursor, cpt) {
     xbt_test_assert0(FALSE, "Damnit, there is something in the empty dynar");
   }
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 
   xbt_test_add0("==== Push/shift 5000 doubles");
   d = xbt_dynar_new(sizeof(double), NULL);
@@ -877,9 +898,9 @@ XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
                      "The retrieved value is not the same than the injected one (%f!=%f)",
                      d1, d2);
   }
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
-
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 
   xbt_test_add0("==== Unshift/pop 5000 doubles");
   d = xbt_dynar_new(sizeof(double), NULL);
@@ -894,8 +915,9 @@ XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
                      "The retrieved value is not the same than the injected one (%f!=%f)",
                      d1, d2);
   }
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 
 
 
@@ -933,8 +955,9 @@ XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
                      "The retrieved value is not the same than the injected one at the end (%f!=%f)",
                      d1, d2);
   }
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 
 
   xbt_test_add0("==== Push 5000 double, remove 2000-4000. free the rest");
@@ -949,8 +972,9 @@ XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
     xbt_test_assert2(d1 == d2,
                      "Remove a bad value. Got %f, expected %f", d2, d1);
   }
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 }
 
 
@@ -972,8 +996,9 @@ XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
   xbt_dynar_foreach(d, iter, s1) {
     xbt_test_assert0(FALSE, "Damnit, there is something in the empty dynar");
   }
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 
   xbt_test_add1("==== Push %d strings, set them again 3 times, shift them",
                 NB_ELEM);
@@ -1008,9 +1033,9 @@ XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
                      buf, s2);
     free(s2);
   }
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
-
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 
   xbt_test_add1("==== Unshift, traverse and pop %d strings", NB_ELEM);
   d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
@@ -1036,8 +1061,9 @@ XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
     free(s2);
   }
   /* 4. Free the resources */
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 
 
   xbt_test_add2
@@ -1079,8 +1105,9 @@ XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
                      buf, s2);
     free(s2);
   }
-  xbt_dynar_free(&d);
-  xbt_dynar_free(&d);
+  xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
+  xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
+                                 /* in your code is naturally the way to go outside a regression test */
 
 
   xbt_test_add3("==== Push %d strings, remove %d-%d. free the rest", NB_ELEM,