2 * SPDX-License-Identifier: MIT
4 * Copyright 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * Static-sized priority heap containing pointers. Based on CLRS,
10 #ifndef BABELTRACE_COMMON_PRIO_HEAP_H
11 #define BABELTRACE_COMMON_PRIO_HEAP_H
14 #include "common/macros.h"
17 size_t len
, alloc_len
;
19 int (*gt
)(void *a
, void *b
);
23 void check_heap(const struct ptr_heap
*heap
);
26 void check_heap(const struct ptr_heap
*heap
__attribute__((unused
)))
32 * bt_heap_maximum - return the largest element in the heap
33 * @heap: the heap to be operated on
35 * Returns the largest element in the heap, without performing any modification
36 * to the heap structure. Returns NULL if the heap is empty.
38 static inline void *bt_heap_maximum(const struct ptr_heap
*heap
)
41 return G_LIKELY(heap
->len
) ? heap
->ptrs
[0] : NULL
;
45 * bt_heap_init - initialize the heap
46 * @heap: the heap to initialize
47 * @alloc_len: number of elements initially allocated
48 * @gt: function to compare the elements
50 * Returns -ENOMEM if out of memory.
52 extern int bt_heap_init(struct ptr_heap
*heap
,
54 int gt(void *a
, void *b
));
57 * bt_heap_free - free the heap
58 * @heap: the heap to free
60 extern void bt_heap_free(struct ptr_heap
*heap
);
63 * bt_heap_insert - insert an element into the heap
64 * @heap: the heap to be operated on
65 * @p: the element to add
67 * Insert an element into the heap.
69 * Returns -ENOMEM if out of memory.
71 extern int bt_heap_insert(struct ptr_heap
*heap
, void *p
);
74 * bt_heap_remove - remove the largest element from the heap
75 * @heap: the heap to be operated on
77 * Returns the largest element in the heap. It removes this element from the
78 * heap. Returns NULL if the heap is empty.
80 extern void *bt_heap_remove(struct ptr_heap
*heap
);
83 * bt_heap_cherrypick - remove a given element from the heap
84 * @heap: the heap to be operated on
87 * Remove the given element from the heap. Return the element if present, else
88 * return NULL. This algorithm has a complexity of O(n), which is higher than
89 * O(log(n)) provided by the rest of this API.
91 extern void *bt_heap_cherrypick(struct ptr_heap
*heap
, void *p
);
94 * bt_heap_replace_max - replace the the largest element from the heap
95 * @heap: the heap to be operated on
96 * @p: the pointer to be inserted as topmost element replacement
98 * Returns the largest element in the heap. It removes this element from the
99 * heap. The heap is rebalanced only once after the insertion. Returns NULL if
102 * This is the equivalent of calling bt_heap_remove() and then bt_heap_insert(), but
103 * it only rebalances the heap once. It never allocates memory.
105 extern void *bt_heap_replace_max(struct ptr_heap
*heap
, void *p
);
108 * bt_heap_copy - copy a heap
109 * @dst: the destination heap (must be allocated)
110 * @src: the source heap
112 * Returns -ENOMEM if out of memory.
114 extern int bt_heap_copy(struct ptr_heap
*dst
, struct ptr_heap
*src
);
116 #endif /* BABELTRACE_COMMON_PRIO_HEAP_H */
This page took 0.031904 seconds and 4 git commands to generate.