X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/707e365f2ebe9132b004da4995f4a705df9e5582..0446fc9e3f379b9aff5e0bb44cf06d06b9e663cc:/include/xbt/heap.h diff --git a/include/xbt/heap.h b/include/xbt/heap.h index 377dbf21c1..99b4d7b948 100644 --- a/include/xbt/heap.h +++ b/include/xbt/heap.h @@ -11,19 +11,23 @@ #include "xbt/misc.h" #include "xbt/dynar.h" /* void_f_pvoid_t */ -/** \brief Heap data type - \ingroup XBT_heap -*/ +/** @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); +/* @} */ #endif /* _XBT_HEAP_H */