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

diff --git a/src/xbt/heap.c b/src/xbt/heap.c
index 8de439f5d5..7f97bd8e02 100644
--- a/src/xbt/heap.c
+++ b/src/xbt/heap.c
@@ -8,22 +8,25 @@
  * 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");
 
-/** \name Functions 
- *  \ingroup XBT_heap
+#include <stdio.h>
+
+
+/** @addtogroup XBT_heap
+ *  \brief This section describes the API to generic heap with O(log(n)) access.
  */
-/*@{*/
+
 /**
+ * @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.
  */
-xbt_heap_t xbt_heap_new(int init_size, void_f_pvoid_t * const free_func)
+xbt_heap_t xbt_heap_new(int init_size, void_f_pvoid_t const free_func)
 {
   xbt_heap_t H = xbt_new0(struct xbt_heap, 1);
   H->size = init_size;
@@ -34,24 +37,24 @@ xbt_heap_t xbt_heap_new(int init_size, void_f_pvoid_t * const free_func)
 }
 
 /**
- * \param 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)
 {
   int i;
   if (H->free)
     for (i = 0; i < H->count; i++)
-      H->free(H->items[i].content);
-  xbt_free(H->items);
-  xbt_free(H);
+      (*(H->free)) (H->items[i].content);
+  free(H->items);
+  free(H);
   return;
 }
 
 /**
- * \param H the heap we're working on
- * \return 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,24 +62,26 @@ int xbt_heap_size(xbt_heap_t H)
 }
 
 /**
+ * @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)
 {
   int count = ++(H->count);
+
   int size = H->size;
   xbt_heapItem_t item;
+
   if (count > size) {
     H->size = 2 * size + 1;
     H->items =
-	(void *) realloc(H->items,
-			 (H->size) * sizeof(struct xbt_heapItem));
+      (void *) realloc(H->items, (H->size) * sizeof(struct xbt_heapItem));
   }
+
   item = &(H->items[count - 1]);
   item->key = key;
   item->content = content;
@@ -85,6 +90,7 @@ void xbt_heap_push(xbt_heap_t H, void *content, double key)
 }
 
 /**
+ * @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
  *
@@ -107,24 +113,25 @@ void *xbt_heap_pop(xbt_heap_t H)
   if (H->count < H->size / 4 && H->size > 16) {
     H->size = H->size / 2 + 1;
     H->items =
-	(void *) realloc(H->items,
-			 (H->size) * sizeof(struct xbt_heapItem));
+      (void *) realloc(H->items, (H->size) * sizeof(struct xbt_heapItem));
   }
   return max;
 }
 
 /**
+ * @brief returns the smallest key in the heap (heap unchanged)
  * \param H the heap we're working on
  *
  * \return the smallest key in the heap without modifying the heap.
  */
 double xbt_heap_maxkey(xbt_heap_t H)
 {
-  xbt_assert0(H->count != 0,"Empty heap");
+  xbt_assert0(H->count != 0, "Empty heap");
   return KEY(H, 0);
 }
 
 /**
+ * @brief returns the value associated to the smallest key in the heap (heap unchanged)
  * \param H the heap we're working on
  *
  * \return the value associated to the smallest key in the heap
@@ -132,13 +139,13 @@ double xbt_heap_maxkey(xbt_heap_t H)
  */
 void *xbt_heap_maxcontent(xbt_heap_t H)
 {
-  xbt_assert0(H->count != 0,"Empty heap");
+  xbt_assert0(H->count != 0, "Empty heap");
   return CONTENT(H, 0);
 }
 
 /* <<<< private >>>>
  * \param H the heap we're working on
- * 
+ *
  * Restores the heap property once an element has been deleted.
  */
 static void xbt_heap_maxHeapify(xbt_heap_t H)
@@ -166,7 +173,7 @@ static void xbt_heap_maxHeapify(xbt_heap_t H)
 /* <<<< 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.
  */
@@ -180,4 +187,3 @@ static void xbt_heap_increaseKey(xbt_heap_t H, int i)
   }
   return;
 }
-/*@}*/