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

diff --git a/src/xbt/heap.c b/src/xbt/heap.c
index f5549a46f0..49e28e40f9 100644
--- a/src/xbt/heap.c
+++ b/src/xbt/heap.c
@@ -1,33 +1,46 @@
+/* 	$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 "heap_private.h"
 
+
+/** \defgroup XBT_heap A generic heap data structure
+ *  \brief This section describes the API to generic heap with O(log(n)) access.
+ */
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(heap, xbt, "Heap");
+
+/** \name Functions 
+ *  \ingroup XBT_heap
+ */
+/*@{*/
 /**
- * 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).
+ * \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 H = calloc(1, sizeof(struct xbt_heap));
+  xbt_heap_t H = xbt_new0(struct xbt_heap, 1);
   H->size = init_size;
   H->count = 0;
-  H->items =
-      (xbt_heapItem_t) calloc(init_size, sizeof(struct xbt_heapItem));
-  H->free = free;
+  H->items = (xbt_heapItem_t) xbt_new0(struct xbt_heapItem, init_size);
+  H->free = free_func;
   return H;
 }
 
 /**
- * xbt_heap_free:
- * @H: poor victim
+ * \param H poor victim
  *
  * kilkil a heap and its content
  */
@@ -35,7 +48,7 @@ void xbt_heap_free(xbt_heap_t H)
 {
   int i;
   if (H->free)
-    for (i = 0; i < H->size; i++)
+    for (i = 0; i < H->count; i++)
       H->free(H->items[i].content);
   free(H->items);
   free(H);
@@ -43,15 +56,23 @@ void xbt_heap_free(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
+ * \param H the heap we're working on
+ * \return the number of elements in the heap
+ */
+int xbt_heap_size(xbt_heap_t H)
+{
+  return (H->count);
+}
+
+/**
+ * \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.
  */
-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;
@@ -70,8 +91,8 @@ void xbt_heap_push(xbt_heap_t H, void *content, xbt_heap_float_t key)
 }
 
 /**
- * xbt_heap_pop:
- * @H: the heap we're working on
+ * \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
@@ -79,7 +100,13 @@ 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 = CONTENT(H, 0);
+  void *max;
+
+  if (H->count == 0)
+    return NULL;
+
+  max = CONTENT(H, 0);
+
   H->items[0] = H->items[(H->count) - 1];
   (H->count)--;
   xbt_heap_maxHeapify(H);
@@ -93,35 +120,34 @@ void *xbt_heap_pop(xbt_heap_t H)
 }
 
 /**
- * xbt_heap_maxkey:
- * @H: the heap we're working on
+ * \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)
 {
+  xbt_assert0(H->count != 0,"Empty heap");
   return KEY(H, 0);
 }
 
 /**
- * xbt_heap_maxcontent:
- * @H: the heap we're working on
+ * \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)
 {
+  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.
  */
-void xbt_heap_maxHeapify(xbt_heap_t H)
+static void xbt_heap_maxHeapify(xbt_heap_t H)
 {
   int i = 0;
   while (1) {
@@ -143,15 +169,14 @@ 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.
  */
-void xbt_heap_increaseKey(xbt_heap_t H, int i)
+static void xbt_heap_increaseKey(xbt_heap_t H, int i)
 {
   while (i > 0 && KEY(H, PARENT(i)) > KEY(H, i)) {
     struct xbt_heapItem tmp = H->items[i];
@@ -161,3 +186,4 @@ void xbt_heap_increaseKey(xbt_heap_t H, int i)
   }
   return;
 }
+/*@}*/