3 /* a generic and efficient heap */
5 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved. */
7 /* This program is free software; you can redistribute it and/or modify it
8 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "xbt/sysdep.h"
11 #include "xbt/error.h"
12 #include "heap_private.h"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(heap, xbt, "Heap");
17 * @init_size: initial size of the heap
18 * @free_func: function to call on each element when you want to free
19 * the whole heap (or NULL if nothing to do).
23 xbt_heap_t xbt_heap_new(int init_size, void_f_pvoid_t * const free_func)
25 xbt_heap_t H = xbt_new0(struct xbt_heap, 1);
28 H->items = (xbt_heapItem_t) xbt_new0(struct xbt_heapItem, init_size);
37 * kilkil a heap and its content
39 void xbt_heap_free(xbt_heap_t H)
43 for (i = 0; i < H->count; i++)
44 H->free(H->items[i].content);
52 * @H: the heap we're working on
54 * returns the number of elements in the heap
56 int xbt_heap_size(xbt_heap_t H)
63 * @H: the heap we're working on
64 * @content: the object you want to add to the heap
65 * @key: the key associated to this object
67 * Add an element int the heap. The element with the smallest key is
68 * automatically moved at the top of the heap.
70 void xbt_heap_push(xbt_heap_t H, void *content, double key)
72 int count = ++(H->count);
76 H->size = 2 * size + 1;
78 (void *) realloc(H->items,
79 (H->size) * sizeof(struct xbt_heapItem));
81 item = &(H->items[count - 1]);
83 item->content = content;
84 xbt_heap_increaseKey(H, count - 1);
90 * @H: the heap we're working on
92 * Extracts from the heap and returns the element with the smallest
93 * key. The element with the next smallest key is automatically moved
94 * at the top of the heap.
96 void *xbt_heap_pop(xbt_heap_t H)
105 H->items[0] = H->items[(H->count) - 1];
107 xbt_heap_maxHeapify(H);
108 if (H->count < H->size / 4 && H->size > 16) {
109 H->size = H->size / 2 + 1;
111 (void *) realloc(H->items,
112 (H->size) * sizeof(struct xbt_heapItem));
119 * @H: the heap we're working on
121 * Returns the smallest key in the heap without modifying the heap.
123 double xbt_heap_maxkey(xbt_heap_t H)
131 * xbt_heap_maxcontent:
132 * @H: the heap we're working on
134 * Returns the value associated to the smallest key in the heap
135 * without modifying the heap.
137 void *xbt_heap_maxcontent(xbt_heap_t H)
141 return CONTENT(H, 0);
145 * xbt_heap_maxcontent:
146 * @H: the heap we're working on
148 * Restores the heap property once an element has been deleted.
150 static void xbt_heap_maxHeapify(xbt_heap_t H)
157 int count = H->count;
158 if (l < count && KEY(H, l) < KEY(H, i))
160 if (r < count && KEY(H, r) < KEY(H, greatest))
163 struct xbt_heapItem tmp = H->items[i];
164 H->items[i] = H->items[greatest];
165 H->items[greatest] = tmp;
173 * xbt_heap_maxcontent:
174 * @H: the heap we're working on
175 * @i: an item position in the heap
177 * Moves up an item at position i to its correct position. Works only
178 * when called from xbt_heap_push. Do not use otherwise.
180 static void xbt_heap_increaseKey(xbt_heap_t H, int i)
182 while (i > 0 && KEY(H, PARENT(i)) > KEY(H, i)) {
183 struct xbt_heapItem tmp = H->items[i];
184 H->items[i] = H->items[PARENT(i)];
185 H->items[PARENT(i)] = tmp;