X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f58700be432433386a2502ca365345a1f5bf3098..1e18ccad74ce3d49299f1da9022c5d5e4ee76918:/include/xbt/heap.h

diff --git a/include/xbt/heap.h b/include/xbt/heap.h
index 85b8c4fb52..27afafceda 100644
--- a/include/xbt/heap.h
+++ b/include/xbt/heap.h
@@ -1,28 +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
 
-typedef struct xbt_heap *xbt_heap_t;
-
-/* The following two definitions concern the type of the keys used for
-   the heaps. That should be handled via configure (FIXME). */
-typedef long double xbt_heap_float_t;
-#define XBT_HEAP_FLOAT_T "%Lg"	/* for printing purposes */
+#include "xbt/misc.h"
+#include "xbt/dynar.h" /* void_f_pvoid_t */
 
-/* pointer to a function freeing something (should be common to all .h : FIXME) */
-typedef void (void_f_pvoid_t) (void *);
+/** @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);
 
-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);
 void *xbt_heap_pop(xbt_heap_t H);
 
-xbt_heap_float_t xbt_heap_maxkey(xbt_heap_t H);
+double xbt_heap_maxkey(xbt_heap_t H);
 void *xbt_heap_maxcontent(xbt_heap_t H);
 
+/* @} */
 #endif				/* _XBT_HEAP_H */