Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Do not execute MCer code in MCed mode in MC_remove_ignore_heap()
[simgrid.git] / include / xbt / heap.h
1 /* Copyright (c) 2004-2007, 2009-2011, 2013-2014. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef _XBT_HEAP_H
8 #define _XBT_HEAP_H
9
10 #include "xbt/misc.h"
11 #include "xbt/dynar.h"          /* void_f_pvoid_t */
12
13 SG_BEGIN_DECL()
14
15 /** @addtogroup XBT_heap
16  *  @brief This section describes the API to generic heap with O(log(n)) access.
17  *
18  *  @{
19  */
20 /* @brief heap datatype */
21 typedef struct xbt_heap *xbt_heap_t;
22
23 XBT_PUBLIC(xbt_heap_t) xbt_heap_new(int init_size,
24                                     void_f_pvoid_t const free_func);
25 XBT_PUBLIC(void) xbt_heap_free(xbt_heap_t H);
26 XBT_PUBLIC(int) xbt_heap_size(xbt_heap_t H);
27
28 XBT_PUBLIC(void) xbt_heap_push(xbt_heap_t H, void *content, double key);
29 XBT_PUBLIC(void *) xbt_heap_pop(xbt_heap_t H);
30
31 XBT_PUBLIC(double) xbt_heap_maxkey(xbt_heap_t H);
32 XBT_PUBLIC(void *) xbt_heap_maxcontent(xbt_heap_t H);
33 XBT_PUBLIC(void) xbt_heap_set_update_callback(xbt_heap_t H,
34                                               void (*update_callback) (void
35                                                                        *,
36                                                                        int));
37 XBT_PUBLIC(void *) xbt_heap_remove(xbt_heap_t H, int i);
38 XBT_PUBLIC(void ) xbt_heap_update(xbt_heap_t H, int i, double key);
39
40 /* @} */
41 SG_END_DECL()
42 #endif                          /* _XBT_HEAP_H */