adding test example to trace process migration using the mask TRACE_PROCESS

[simgrid.git] / include / xbt / heap.h

diff --git a/include/xbt/heap.h b/include/xbt/heap.h
index 2b44138..16f5126 100644 (file)
--- a/include/xbt/heap.h
+++ b/include/xbt/heap.h
@@ -9,20 +9,27 @@
 #define _XBT_HEAP_H
 
 #include "xbt/misc.h"
-
-/** \brief Heap data type 
-    \ingroup XBT_heap
-*/
+#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, double 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);
 
-double 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);
+XBT_PUBLIC(void) xbt_heap_set_update_callback(xbt_heap_t H, void (*update_callback)(void*, int));
+XBT_PUBLIC(void*) xbt_heap_remove(xbt_heap_t H, int i);
 
-#endif                         /* _XBT_HEAP_H */
+/* @} */
+#endif /* _XBT_HEAP_H */