X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d25ee31741e8dd64436721b11fe82a0969f369cf..8750e7f378b5d48477e1b0b2796a437366a3ea2b:/src/xbt/heap.c

diff --git a/src/xbt/heap.c b/src/xbt/heap.c
index d9c31a1977..1357fce1da 100644
--- a/src/xbt/heap.c
+++ b/src/xbt/heap.c
@@ -8,14 +8,18 @@
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "xbt/sysdep.h"
-#include "xbt/error.h"
+#include "xbt/log.h"
 #include "heap_private.h"
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(heap, xbt, "Heap");
+
+
+/** @addtogroup XBT_heap 
+ *  \brief This section describes the API to generic heap with O(log(n)) access.
+ */
 
 /**
- * xbt_heap_new:
- * @init_size: initial size of the heap
- * @free_func: function to call on each element when you want to free
+ * @brief Creates a new heap.
+ * \param init_size initial size of the heap
+ * \param free_func function to call on each element when you want to free
  *             the whole heap (or NULL if nothing to do).
  *
  * Creates a new heap.
@@ -31,10 +35,8 @@ xbt_heap_t xbt_heap_new(int init_size, void_f_pvoid_t * const free_func)
 }
 
 /**
- * xbt_heap_free:
- * @H: poor victim
- *
- * kilkil a heap and its content
+ * @brief kilkil a heap and its content
+ * @param H poor victim
  */
 void xbt_heap_free(xbt_heap_t H)
 {
@@ -42,16 +44,15 @@ void xbt_heap_free(xbt_heap_t H)
   if (H->free)
     for (i = 0; i < H->count; i++)
       H->free(H->items[i].content);
-  xbt_free(H->items);
-  xbt_free(H);
+  free(H->items);
+  free(H);
   return;
 }
 
 /**
- * xbt_heap_size:
- * @H: the heap we're working on
- *
- * returns the number of elements in the heap
+ * @brief returns the number of elements in the heap
+ * @param H the heap we're working on
+ * @return the number of elements in the heap
  */
 int xbt_heap_size(xbt_heap_t H)
 {
@@ -59,13 +60,12 @@ int xbt_heap_size(xbt_heap_t H)
 }
 
 /**
- * xbt_heap_push:
- * @H: the heap we're working on
- * @content: the object you want to add to the heap
- * @key: the key associated to this object
+ * @brief Add an element into the heap.
+ * \param H the heap we're working on
+ * \param content the object you want to add to the heap
+ * \param key the key associated to this object
  *
- * Add an element int the heap. The element with the smallest key is
- * automatically moved at the top of the heap.
+ * The element with the smallest key is automatically moved at the top of the heap.
  */
 void xbt_heap_push(xbt_heap_t H, void *content, double key)
 {
@@ -86,8 +86,9 @@ void xbt_heap_push(xbt_heap_t H, void *content, double key)
 }
 
 /**
- * xbt_heap_pop:
- * @H: the heap we're working on
+ * @brief Extracts from the heap and returns the element with the smallest key.
+ * \param H the heap we're working on
+ * \return the element with the smallest key
  *
  * Extracts from the heap and returns the element with the smallest
  * key. The element with the next smallest key is automatically moved
@@ -115,35 +116,32 @@ void *xbt_heap_pop(xbt_heap_t H)
 }
 
 /**
- * xbt_heap_maxkey:
- * @H: the heap we're working on
+ * @brief returns the smallest key in the heap (heap unchanged)
+ * \param H the heap we're working on
  *
- * Returns the smallest key in the heap without modifying the heap.
+ * \return the smallest key in the heap without modifying the heap.
  */
 double xbt_heap_maxkey(xbt_heap_t H)
 {
-  if (H->count == 0)
-    abort();
+  xbt_assert0(H->count != 0,"Empty heap");
   return KEY(H, 0);
 }
 
 /**
- * xbt_heap_maxcontent:
- * @H: the heap we're working on
+ * @brief returns the value associated to the smallest key in the heap (heap unchanged)
+ * \param H the heap we're working on
  *
- * Returns the value associated to the smallest key in the heap
+ * \return the value associated to the smallest key in the heap
  * without modifying the heap.
  */
 void *xbt_heap_maxcontent(xbt_heap_t H)
 {
-  if (H->count == 0)
-    abort();
+  xbt_assert0(H->count != 0,"Empty heap");
   return CONTENT(H, 0);
 }
 
-/**
- * xbt_heap_maxcontent:
- * @H: the heap we're working on
+/* <<<< private >>>>
+ * \param H the heap we're working on
  * 
  * Restores the heap property once an element has been deleted.
  */
@@ -169,10 +167,9 @@ static void xbt_heap_maxHeapify(xbt_heap_t H)
   }
 }
 
-/**
- * xbt_heap_maxcontent:
- * @H: the heap we're working on
- * @i: an item position in the heap
+/* <<<< private >>>>
+ * \param H the heap we're working on
+ * \param i an item position in the heap
  * 
  * Moves up an item at position i to its correct position. Works only
  * when called from xbt_heap_push. Do not use otherwise.