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] / src / xbt / heap.c
1 /* a generic and efficient heap                                             */
2
3 /* Copyright (c) 2004-2005, 2007-2014. The SimGrid Team.
4  * All rights reserved.                                                     */
5
6 /* This program is free software; you can redistribute it and/or modify it
7  * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 #include "xbt/sysdep.h"
10 #include "xbt/log.h"
11 #include "heap_private.h"
12
13 #include <stdio.h>
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_heap, xbt, "Heap");
15
16 static void xbt_heap_max_heapify(xbt_heap_t H, int i);
17 static void xbt_heap_increase_key(xbt_heap_t H, int i);
18
19 /** @addtogroup XBT_heap
20  *  \brief This section describes the API to generic heap with O(log(n)) access.
21  */
22
23 /**
24  * @brief Creates a new heap.
25  * \param init_size initial size of the heap
26  * \param free_func function to call on each element when you want to free
27  *             the whole heap (or NULL if nothing to do).
28  *
29  * Creates a new heap.
30  */
31 XBT_INLINE xbt_heap_t xbt_heap_new(int init_size,
32                                    void_f_pvoid_t const free_func)
33 {
34   xbt_heap_t H = xbt_new0(struct xbt_heap, 1);
35   H->size = init_size;
36   H->count = 0;
37   H->items = (xbt_heap_item_t) xbt_new0(struct xbt_heap_item, init_size);
38   H->free = free_func;
39   return H;
40 }
41
42 /**
43  * @brief Set the update callback function.
44  * @param H the heap we're working on
45  * \param update_callback function to call on each element to update its index when needed.
46  */
47 XBT_INLINE void xbt_heap_set_update_callback(xbt_heap_t H,
48                                              void (*update_callback) (void
49                                                                       *,
50                                                                       int))
51 {
52   H->update_callback = update_callback;
53 }
54
55
56 /**
57  * @brief kilkil a heap and its content
58  * @param H poor victim
59  */
60 void xbt_heap_free(xbt_heap_t H)
61 {
62   int i;
63   if (H->free)
64     for (i = 0; i < H->count; i++)
65       H->free(H->items[i].content);
66   free(H->items);
67   free(H);
68   return;
69 }
70
71 /**
72  * @brief returns the number of elements in the heap
73  * @param H the heap we're working on
74  * @return the number of elements in the heap
75  */
76 XBT_INLINE int xbt_heap_size(xbt_heap_t H)
77 {
78   return (H->count);
79 }
80
81 /**
82  * @brief Add an element into the heap.
83  * \param H the heap we're working on
84  * \param content the object you want to add to the heap
85  * \param key the key associated to this object
86  *
87  * The element with the smallest key is automatically moved at the top of the heap.
88  */
89 void xbt_heap_push(xbt_heap_t H, void *content, double key)
90 {
91   int count = ++(H->count);
92
93   int size = H->size;
94   xbt_heap_item_t item;
95
96   if (count > size) {
97     H->size = (size << 1) + 1;
98     H->items =
99         (void *) xbt_realloc(H->items,
100                          (H->size) * sizeof(struct xbt_heap_item));
101   }
102
103   item = &(H->items[count - 1]);
104   item->key = key;
105   item->content = content;
106   xbt_heap_increase_key(H, count - 1);
107   XBT_DEBUG("Heap has now %d elements and max elem is %g",xbt_heap_size(H),xbt_heap_maxkey(H));
108   return;
109 }
110
111
112 /**
113  * @brief Extracts from the heap and returns the element with the smallest key.
114  * \param H the heap we're working on
115  * \return the element with the smallest key
116  *
117  * Extracts from the heap and returns the element with the smallest
118  * key. The element with the next smallest key is automatically moved
119  * at the top of the heap.
120  */
121 void *xbt_heap_pop(xbt_heap_t H)
122 {
123   xbt_heap_item_t items = H->items;
124   int size = H->size;
125   void *max;
126
127   if (H->count == 0)
128     return NULL;
129
130   XBT_DEBUG("Heap has %d elements before extraction and max elem was %g",xbt_heap_size(H),xbt_heap_maxkey(H));
131
132   max = CONTENT(H, 0);
133
134   items[0] = items[(H->count) - 1];
135   (H->count)--;
136   xbt_heap_max_heapify(H,0);
137   if (H->count < size >> 2 && size > 16) {
138     size = (size >> 1) + 1;
139     H->items =
140         (void *) xbt_realloc(items,
141                          size * sizeof(struct xbt_heap_item));
142     H->size = size;
143   }
144
145   if (H->update_callback)
146     H->update_callback(max, -1);
147   return max;
148 }
149
150 /**
151  * @brief Extracts from the heap and returns the element at position i.
152  * \param H the heap we're working on
153  * \param i  element position
154  * \return the element at position i if ok, NULL otherwise
155  *
156  * Extracts from the heap and returns the element at position i. The heap is automatically reorded.
157  */
158 void *xbt_heap_remove(xbt_heap_t H, int i)
159 {
160   XBT_DEBUG("Heap has %d elements: extracting element %d",xbt_heap_size(H),i);
161
162   if ((i < 0) || (i > H->count - 1))
163     return NULL;
164   /* put element i at head */
165   if (i > 0) {
166     KEY(H, i) = MIN_KEY_VALUE;
167     xbt_heap_increase_key(H, i);
168   }
169
170   return xbt_heap_pop(H);
171 }
172
173 /**
174  * @brief Updates an element of the heap with a new value.
175  * \param H the heap we're working on
176  * \param i  element position
177  * \param key new value for the element
178  *
179  * Updates an element of the heap with a new value.
180  */
181 void xbt_heap_update(xbt_heap_t H, int i, double key)
182 {
183   XBT_DEBUG("Heap has %d elements: updating element %d : was %1.12f to %1.12f ",xbt_heap_size(H),i,KEY(H, i), key);
184
185   if ((i < 0) || (i > H->count - 1) || key == KEY(H, i))
186     return ;
187
188   if(key< KEY(H, i)){
189     KEY(H, i)=key;
190     xbt_heap_increase_key(H, i);
191   }else{
192     KEY(H, i)=key;
193     xbt_heap_max_heapify(H,i);
194   }
195 }
196
197 /**
198  * @brief returns the smallest key in the heap (heap unchanged)
199  * \param H the heap we're working on
200  *
201  * \return the smallest key in the heap without modifying the heap.
202  */
203 XBT_INLINE double xbt_heap_maxkey(xbt_heap_t H)
204 {
205   xbt_assert(H->count != 0, "Empty heap");
206   return KEY(H, 0);
207 }
208
209 /**
210  * @brief returns the value associated to the smallest key in the heap (heap unchanged)
211  * \param H the heap we're working on
212  *
213  * \return the value associated to the smallest key in the heap
214  * without modifying the heap.
215  */
216 void *xbt_heap_maxcontent(xbt_heap_t H)
217 {
218   xbt_assert(H->count != 0, "Empty heap");
219   return CONTENT(H, 0);
220 }
221
222 /* <<<< private >>>>
223  * \param H the heap we're working on
224  *
225  * Restores the heap property once an element has been deleted.
226  */
227 static void xbt_heap_max_heapify(xbt_heap_t H, int index)
228 {
229   int i = index;
230   int count = H->count;
231   xbt_heap_item_t items = H->items;
232
233   while (1) {
234     int greatest = i;
235     int l = LEFT(i);
236     int r = l + 1;
237     if (l < count && items[l].key < items[i].key)
238       greatest = l;
239     if (r < count && items[r].key < items[greatest].key)
240       greatest = r;
241     if (greatest != i) {
242       struct xbt_heap_item tmp = items[i];
243       items[i] = items[greatest];
244       items[greatest] = tmp;
245       if (H->update_callback)
246         H->update_callback(items[i].content, i);
247       i = greatest;
248     } else {
249       if (H->update_callback)
250         H->update_callback(items[i].content, i);
251       return;
252     }
253   }
254 }
255
256 /* <<<< private >>>>
257  * \param H the heap we're working on
258  * \param i an item position in the heap
259  *
260  * Moves up an item at position i to its correct position. Works only
261  * when called from xbt_heap_push. Do not use otherwise.
262  */
263 static void xbt_heap_increase_key(xbt_heap_t H, int i)
264 {
265   xbt_heap_item_t items = H->items;
266   int p = PARENT(i);
267   while (i > 0 && items[p].key > items[i].key) {
268     struct xbt_heap_item tmp = items[i];
269     items[i] = items[p];
270     items[p] = tmp;
271     if (H->update_callback)
272       H->update_callback(items[i].content, i);
273     i = p;
274     p = PARENT(i);
275   }
276   if (H->update_callback)
277     H->update_callback(items[i].content, i);
278   return;
279 }