X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/32f13ca1c7961662a097b1b906f589a851bb3611..12900371925594a27b91457d6db67020eb4df4e5:/include/xbt/heap.h

diff --git a/include/xbt/heap.h b/include/xbt/heap.h
index ec853b622e..dda24d486c 100644
--- a/include/xbt/heap.h
+++ b/include/xbt/heap.h
@@ -1,29 +1,43 @@
-/* Authors: Arnaud Legrand                                                  */
+/* Copyright (c) 2004-2007, 2009-2011, 2013-2014. 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;
-
-/* 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*);
+SG_BEGIN_DECL()
 
-xbt_heap_t xbt_heap_new(int num, void_f_pvoid_t free_func);
-void xbt_heap_free(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_heap_float_t xbt_heap_maxkey(xbt_heap_t H);
-void *xbt_heap_maxcontent(xbt_heap_t H);
+/** @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;
 
-#endif /* _XBT_HEAP_H */
+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_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);
+
+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);
+
+/* @} */
+SG_END_DECL()
+#endif                          /* _XBT_HEAP_H */