X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/704c020a28078a73f3592425ba5b7d9bade8455e..66d97e68ea51b5514594e5818f75c7d844586eae:/include/xbt/heap.h

diff --git a/include/xbt/heap.h b/include/xbt/heap.h
index 56f0ef189b..99b4d7b948 100644
--- a/include/xbt/heap.h
+++ b/include/xbt/heap.h
@@ -1,23 +1,33 @@
-/* Authors: Arnaud Legrand                                                  */
+/* 	$Id$	 */
+
+/* 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. */
 
 #ifndef _XBT_HEAP_H
 #define _XBT_HEAP_H
 
 #include "xbt/misc.h"
-
+#include "xbt/dynar.h" /* void_f_pvoid_t */
+
+/** @addtogroup XBT_heap
+ *  @brief This section describes the API to generic heap with O(log(n)) access.
+ *
+ *  @{
+ */
+/* @brief heap datatype */
 typedef struct xbt_heap *xbt_heap_t;
 
-xbt_heap_t xbt_heap_new(int num, void_f_pvoid_t free_func);
-void xbt_heap_free(xbt_heap_t H);
-int xbt_heap_size(xbt_heap_t H);
+XBT_PUBLIC(xbt_heap_t) xbt_heap_new(int num, void_f_pvoid_t const free_func);
+XBT_PUBLIC(void) xbt_heap_free(xbt_heap_t H);
+XBT_PUBLIC(int) xbt_heap_size(xbt_heap_t H);
 
-void xbt_heap_push(xbt_heap_t H, void *content, xbt_heap_float_t key);
-void *xbt_heap_pop(xbt_heap_t H);
+XBT_PUBLIC(void) xbt_heap_push(xbt_heap_t H, void *content, double key);
+XBT_PUBLIC(void*) xbt_heap_pop(xbt_heap_t H);
 
-xbt_heap_float_t xbt_heap_maxkey(xbt_heap_t H);
-void *xbt_heap_maxcontent(xbt_heap_t H);
+XBT_PUBLIC(double) xbt_heap_maxkey(xbt_heap_t H);
+XBT_PUBLIC(void*) xbt_heap_maxcontent(xbt_heap_t H);
 
+/* @} */
 #endif				/* _XBT_HEAP_H */