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

diff --git a/include/xbt/heap.h b/include/xbt/heap.h
index 85b8c4fb52..3fe2951540 100644
--- a/include/xbt/heap.h
+++ b/include/xbt/heap.h
@@ -1,28 +1,42 @@
-/* Authors: Arnaud Legrand                                                  */
+/* Copyright (c) 2004-2007, 2009-2011, 2013-2015. The SimGrid Team.
+ * 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;
+#include "xbt/misc.h"
+#include "xbt/dynar.h"          /* void_f_pvoid_t */
+
+SG_BEGIN_DECL()
 
-/* 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 */
+/** @addtogroup XBT_heap
+ *  @brief This section describes the API to generic heap with O(log(n)) access.
+ *
+ *  If you are using C++ you might want to use std::priority_queue instead.
+ *
+ *  @{
+ */
+/* @brief heap datatype */
+typedef struct xbt_heap *xbt_heap_t;
 
-/* pointer to a function freeing something (should be common to all .h : FIXME) */
-typedef void (void_f_pvoid_t) (void *);
+XBT_PUBLIC(xbt_heap_t) xbt_heap_new(int init_size, 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);
 
-xbt_heap_t xbt_heap_new(int num, void_f_pvoid_t free_func);
-void xbt_heap_free(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_PUBLIC(void) xbt_heap_rm_elm(xbt_heap_t H, void *content, double key);
 
-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(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);
+XBT_PUBLIC(void ) xbt_heap_update(xbt_heap_t H, int i, double key);
 
-xbt_heap_float_t xbt_heap_maxkey(xbt_heap_t H);
-void *xbt_heap_maxcontent(xbt_heap_t H);
+/* @} */
+SG_END_DECL()
 
-#endif				/* _XBT_HEAP_H */
+#endif                          /* _XBT_HEAP_H */