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

diff --git a/src/xbt/heap.c b/src/xbt/heap.c
index e30291fa9a..19db0112e1 100644
--- a/src/xbt/heap.c
+++ b/src/xbt/heap.c
@@ -1,19 +1,28 @@
+/* 	$Id$	 */
+
 /* a generic and efficient heap                                             */
 
-/* Authors: Arnaud Legrand                                                  */
+/* Copyright (c) 2004 Arnaud Legrand. 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. */
+ * 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");
+
+#include <stdio.h>
+
+
+/** @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 the whole heap (or NULL if nothing to do).
+ * @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.
  */
@@ -28,10 +37,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)
 {
@@ -39,16 +46,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)
 {
@@ -56,35 +62,36 @@ 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, xbt_heap_float_t key)
+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));
-  }
-  item = &(H->items[count - 1]);
-  item->key = key;
-  item->content = content;
-  xbt_heap_increaseKey(H, count - 1);
-  return;
+	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));
+	}
+	
+	item = &(H->items[count - 1]);
+	item->key = key;
+	item->content = content;
+	xbt_heap_increaseKey(H, count - 1);
+	return;
 }
 
 /**
- * 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
@@ -92,9 +99,10 @@ void xbt_heap_push(xbt_heap_t H, void *content, xbt_heap_float_t key)
  */
 void *xbt_heap_pop(xbt_heap_t H)
 {
-  void *max ;
+  void *max;
 
-  if(H->count==0) return NULL;
+  if (H->count == 0)
+    return NULL;
 
   max = CONTENT(H, 0);
 
@@ -111,33 +119,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.
  */
-xbt_heap_float_t xbt_heap_maxkey(xbt_heap_t H)
+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.
  */
@@ -163,10 +170,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.