Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Sanitize the documentation of heap: group defined in module-xbt.doc, its content...
[simgrid.git] / include / xbt / heap.h
1 /*      $Id$     */
2
3 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8 #ifndef _XBT_HEAP_H
9 #define _XBT_HEAP_H
10
11 #include "xbt/misc.h"
12 #include "xbt/dynar.h" /* void_f_pvoid_t */
13
14 /** @addtogroup XBT_heap
15  *
16  *  @{
17  */
18 /* @brief heap datatype */
19 typedef struct xbt_heap *xbt_heap_t;
20
21 xbt_heap_t xbt_heap_new(int num, void_f_pvoid_t free_func);
22 void xbt_heap_free(xbt_heap_t H);
23 int xbt_heap_size(xbt_heap_t H);
24
25 void xbt_heap_push(xbt_heap_t H, void *content, double key);
26 void *xbt_heap_pop(xbt_heap_t H);
27
28 double xbt_heap_maxkey(xbt_heap_t H);
29 void *xbt_heap_maxcontent(xbt_heap_t H);
30
31 /* @} */
32 #endif                          /* _XBT_HEAP_H */