-/* a generic and efficient heap */\r
-\r
-/* Copyright (c) 2004, 2005, 2007, 2008, 2009, 2010. The SimGrid Team.\r
- * All rights reserved. */\r
-\r
-/* This program is free software; you can redistribute it and/or modify it\r
- * under the terms of the license (GNU LGPL) which comes with this package. */\r
-\r
-#include "xbt/sysdep.h"\r
-#include "xbt/log.h"\r
-#include "heap_private.h"\r
-\r
-#include <stdio.h>\r
-\r
-\r
-/** @addtogroup XBT_heap\r
- * \brief This section describes the API to generic heap with O(log(n)) access.\r
- */\r
-\r
-/**\r
- * @brief Creates a new heap.\r
- * \param init_size initial size of the heap\r
- * \param free_func function to call on each element when you want to free\r
- * the whole heap (or NULL if nothing to do).\r
- *\r
- * Creates a new heap.\r
- */\r
-XBT_INLINE xbt_heap_t xbt_heap_new(int init_size, void_f_pvoid_t const free_func)\r
-{\r
- xbt_heap_t H = xbt_new0(struct xbt_heap, 1);\r
- H->size = init_size;\r
- H->count = 0;\r
- H->items = (xbt_heapItem_t) xbt_new0(struct xbt_heapItem, init_size);\r
- H->free = free_func;\r
- return H;\r
-}\r
-\r
-/**\r
- * @brief Set the update callback function.\r
- * @param H the heap we're working on\r
- * \param update_callback function to call on each element to update its index when needed.\r
- */\r
-XBT_INLINE void xbt_heap_set_update_callback(xbt_heap_t H,\r
- void (*update_callback) (void *, int))\r
-{\r
- H->update_callback = update_callback;\r
-}\r
-\r
-\r
-/**\r
- * @brief kilkil a heap and its content\r
- * @param H poor victim\r
- */\r
-void xbt_heap_free(xbt_heap_t H)\r
-{\r
- int i;\r
- if (H->free)\r
- for (i = 0; i < H->count; i++)\r
- (*(H->free)) (H->items[i].content);\r
- free(H->items);\r
- free(H);\r
- return;\r
-}\r
-\r
-/**\r
- * @brief returns the number of elements in the heap\r
- * @param H the heap we're working on\r
- * @return the number of elements in the heap\r
- */\r
-XBT_INLINE int xbt_heap_size(xbt_heap_t H)\r
-{\r
- return (H->count);\r
-}\r
-\r
-/**\r
- * @brief Add an element into the heap.\r
- * \param H the heap we're working on\r
- * \param content the object you want to add to the heap\r
- * \param key the key associated to this object\r
- *\r
- * The element with the smallest key is automatically moved at the top of the heap.\r
- */\r
-void xbt_heap_push(xbt_heap_t H, void *content, double key)\r
-{\r
- int count = ++(H->count);\r
-\r
- int size = H->size;\r
- xbt_heapItem_t item;\r
-\r
- if (count > size) {\r
- H->size = 2 * size + 1;\r
- H->items =\r
- (void *) realloc(H->items, (H->size) * sizeof(struct xbt_heapItem));\r
- }\r
-\r
- item = &(H->items[count - 1]);\r
- item->key = key;\r
- item->content = content;\r
- xbt_heap_increaseKey(H, count - 1);\r
- return;\r
-}\r
-\r
-/**\r
- * @brief Extracts from the heap and returns the element with the smallest key.\r
- * \param H the heap we're working on\r
- * \return the element with the smallest key\r
- *\r
- * Extracts from the heap and returns the element with the smallest\r
- * key. The element with the next smallest key is automatically moved\r
- * at the top of the heap.\r
- */\r
-void *xbt_heap_pop(xbt_heap_t H)\r
-{\r
- void *max;\r
-\r
- if (H->count == 0)\r
- return NULL;\r
-\r
- max = CONTENT(H, 0);\r
-\r
- H->items[0] = H->items[(H->count) - 1];\r
- (H->count)--;\r
- xbt_heap_maxHeapify(H);\r
- if (H->count < H->size / 4 && H->size > 16) {\r
- H->size = H->size / 2 + 1;\r
- H->items =\r
- (void *) realloc(H->items, (H->size) * sizeof(struct xbt_heapItem));\r
- }\r
-\r
- if(H->update_callback) H->update_callback(max, -1);\r
- return max;\r
-}\r
-\r
-/**\r
- * @brief Extracts from the heap and returns the element at position i.\r
- * \param H the heap we're working on\r
- * \param i element position\r
- * \return the element at position i if ok, NULL otherwise\r
- *\r
- * Extracts from the heap and returns the element at position i. The head is automatically reorded.\r
- */\r
-void *xbt_heap_remove(xbt_heap_t H, int i)\r
-{\r
- if ((i < 0) || (i > H->count - 1))\r
- return NULL;\r
- /* put element i at head */\r
- if (i > 0) {\r
- KEY(H, i) = MIN_KEY_VALUE;\r
- xbt_heap_increaseKey(H, i);\r
- }\r
-\r
- return xbt_heap_pop(H);\r
-}\r
-\r
-/**\r
- * @brief returns the smallest key in the heap (heap unchanged)\r
- * \param H the heap we're working on\r
- *\r
- * \return the smallest key in the heap without modifying the heap.\r
- */\r
-XBT_INLINE double xbt_heap_maxkey(xbt_heap_t H)\r
-{\r
- xbt_assert0(H->count != 0, "Empty heap");\r
- return KEY(H, 0);\r
-}\r
-\r
-/**\r
- * @brief returns the value associated to the smallest key in the heap (heap unchanged)\r
- * \param H the heap we're working on\r
- *\r
- * \return the value associated to the smallest key in the heap\r
- * without modifying the heap.\r
- */\r
-void *xbt_heap_maxcontent(xbt_heap_t H)\r
-{\r
- xbt_assert0(H->count != 0, "Empty heap");\r
- return CONTENT(H, 0);\r
-}\r
-\r
-/* <<<< private >>>>\r
- * \param H the heap we're working on\r
- *\r
- * Restores the heap property once an element has been deleted.\r
- */\r
-static void xbt_heap_maxHeapify(xbt_heap_t H)\r
-{\r
- int i = 0;\r
- while (1) {\r
- int greatest = i;\r
- int l = LEFT(i);\r
- int r = RIGHT(i);\r
- int count = H->count;\r
- if (l < count && KEY(H, l) < KEY(H, i))\r
- greatest = l;\r
- if (r < count && KEY(H, r) < KEY(H, greatest))\r
- greatest = r;\r
- if (greatest != i) {\r
- struct xbt_heapItem tmp = H->items[i];\r
- H->items[i] = H->items[greatest];\r
- H->items[greatest] = tmp;\r
- if(H->update_callback) H->update_callback(CONTENT(H, i), i);\r
- i = greatest;\r
- } else {\r
- if(H->update_callback) H->update_callback(CONTENT(H, i), i);\r
- return;\r
- }\r
- }\r
-}\r
-\r
-/* <<<< private >>>>\r
- * \param H the heap we're working on\r
- * \param i an item position in the heap\r
- *\r
- * Moves up an item at position i to its correct position. Works only\r
- * when called from xbt_heap_push. Do not use otherwise.\r
- */\r
-static void xbt_heap_increaseKey(xbt_heap_t H, int i)\r
-{\r
- while (i > 0 && KEY(H, PARENT(i)) > KEY(H, i)) {\r
- struct xbt_heapItem tmp = H->items[i];\r
- H->items[i] = H->items[PARENT(i)];\r
- H->items[PARENT(i)] = tmp;\r
- if(H->update_callback) H->update_callback(CONTENT(H, i), i);\r
- i = PARENT(i);\r
- }\r
- if(H->update_callback) H->update_callback(CONTENT(H, i), i);\r
- return;\r
-}\r
-\r
+/* a generic and efficient heap */
+
+/* Copyright (c) 2004-2005, 2007-2013. The SimGrid Team.
+ * All rights reserved. */
+
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
+#include "xbt/sysdep.h"
+#include "xbt/log.h"
+#include "heap_private.h"
+
+#include <stdio.h>
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_heap, xbt, "Heap");
+
+static void xbt_heap_max_heapify(xbt_heap_t H);
+static void xbt_heap_increase_key(xbt_heap_t H, int i);
+
+/** @addtogroup XBT_heap
+ * \brief This section describes the API to generic heap with O(log(n)) access.
+ */
+
+/**
+ * @brief Creates a new heap.
+ * \param init_size initial size of the heap
+ * \param free_func function to call on each element when you want to free
+ * the whole heap (or NULL if nothing to do).
+ *
+ * Creates a new heap.
+ */
+XBT_INLINE xbt_heap_t xbt_heap_new(int init_size,
+ void_f_pvoid_t const free_func)
+{
+ xbt_heap_t H = xbt_new0(struct xbt_heap, 1);
+ H->size = init_size;
+ H->count = 0;
+ H->items = (xbt_heap_item_t) xbt_new0(struct xbt_heap_item, init_size);
+ H->free = free_func;
+ return H;
+}
+
+/**
+ * @brief Set the update callback function.
+ * @param H the heap we're working on
+ * \param update_callback function to call on each element to update its index when needed.
+ */
+XBT_INLINE void xbt_heap_set_update_callback(xbt_heap_t H,
+ void (*update_callback) (void
+ *,
+ int))
+{
+ H->update_callback = update_callback;
+}
+
+
+/**
+ * @brief kilkil a heap and its content
+ * @param H poor victim
+ */
+void xbt_heap_free(xbt_heap_t H)
+{
+ int i;
+ if (H->free)
+ for (i = 0; i < H->count; i++)
+ H->free(H->items[i].content);
+ free(H->items);
+ free(H);
+ return;
+}
+
+/**
+ * @brief returns the number of elements in the heap
+ * @param H the heap we're working on
+ * @return the number of elements in the heap
+ */
+XBT_INLINE int xbt_heap_size(xbt_heap_t H)
+{
+ return (H->count);
+}
+
+/**
+ * @brief Add an element into the heap.
+ * \param H the heap we're working on
+ * \param content the object you want to add to the heap
+ * \param key the key associated to this object
+ *
+ * The element with the smallest key is automatically moved at the top of the heap.
+ */
+void xbt_heap_push(xbt_heap_t H, void *content, double key)
+{
+ int count = ++(H->count);
+
+ int size = H->size;
+ xbt_heap_item_t item;
+
+ if (count > size) {
+ H->size = (size << 1) + 1;
+ H->items =
+ (void *) xbt_realloc(H->items,
+ (H->size) * sizeof(struct xbt_heap_item));
+ }
+
+ item = &(H->items[count - 1]);
+ item->key = key;
+ item->content = content;
+ xbt_heap_increase_key(H, count - 1);
+ XBT_DEBUG("Heap has now %d elements and max elem is %g",xbt_heap_size(H),xbt_heap_maxkey(H));
+ return;
+}
+
+/**
+ * @brief Extracts from the heap and returns the element with the smallest key.
+ * \param H the heap we're working on
+ * \return the element with the smallest key
+ *
+ * Extracts from the heap and returns the element with the smallest
+ * key. The element with the next smallest key is automatically moved
+ * at the top of the heap.
+ */
+void *xbt_heap_pop(xbt_heap_t H)
+{
+ xbt_heap_item_t items = H->items;
+ int size = H->size;
+ void *max;
+
+ if (H->count == 0)
+ return NULL;
+
+ XBT_DEBUG("Heap has %d elements before extraction and max elem was %g",xbt_heap_size(H),xbt_heap_maxkey(H));
+
+ max = CONTENT(H, 0);
+
+ items[0] = items[(H->count) - 1];
+ (H->count)--;
+ xbt_heap_max_heapify(H);
+ if (H->count < size >> 2 && size > 16) {
+ size = (size >> 1) + 1;
+ H->items =
+ (void *) xbt_realloc(items,
+ size * sizeof(struct xbt_heap_item));
+ H->size = size;
+ }
+
+ if (H->update_callback)
+ H->update_callback(max, -1);
+ return max;
+}
+
+/**
+ * @brief Extracts from the heap and returns the element at position i.
+ * \param H the heap we're working on
+ * \param i element position
+ * \return the element at position i if ok, NULL otherwise
+ *
+ * Extracts from the heap and returns the element at position i. The heap is automatically reorded.
+ */
+void *xbt_heap_remove(xbt_heap_t H, int i)
+{
+ XBT_DEBUG("Heap has %d elements: extracting element %d",xbt_heap_size(H),i);
+
+ if ((i < 0) || (i > H->count - 1))
+ return NULL;
+ /* put element i at head */
+ if (i > 0) {
+ KEY(H, i) = MIN_KEY_VALUE;
+ xbt_heap_increase_key(H, i);
+ }
+
+ return xbt_heap_pop(H);
+}
+
+/**
+ * @brief returns the smallest key in the heap (heap unchanged)
+ * \param H the heap we're working on
+ *
+ * \return the smallest key in the heap without modifying the heap.
+ */
+XBT_INLINE double xbt_heap_maxkey(xbt_heap_t H)
+{
+ xbt_assert(H->count != 0, "Empty heap");
+ return KEY(H, 0);
+}
+
+/**
+ * @brief returns the value associated to the smallest key in the heap (heap unchanged)
+ * \param H the heap we're working on
+ *
+ * \return the value associated to the smallest key in the heap
+ * without modifying the heap.
+ */
+void *xbt_heap_maxcontent(xbt_heap_t H)
+{
+ xbt_assert(H->count != 0, "Empty heap");
+ return CONTENT(H, 0);
+}
+
+/* <<<< private >>>>
+ * \param H the heap we're working on
+ *
+ * Restores the heap property once an element has been deleted.
+ */
+static void xbt_heap_max_heapify(xbt_heap_t H)
+{
+ int i = 0;
+ int count = H->count;
+ xbt_heap_item_t items = H->items;
+
+ while (1) {
+ int greatest = i;
+ int l = LEFT(i);
+ int r = l + 1;
+ if (l < count && items[l].key < items[i].key)
+ greatest = l;
+ if (r < count && items[r].key < items[greatest].key)
+ greatest = r;
+ if (greatest != i) {
+ struct xbt_heap_item tmp = items[i];
+ items[i] = items[greatest];
+ items[greatest] = tmp;
+ if (H->update_callback)
+ H->update_callback(items[i].content, i);
+ i = greatest;
+ } else {
+ if (H->update_callback)
+ H->update_callback(items[i].content, i);
+ return;
+ }
+ }
+}
+
+/* <<<< private >>>>
+ * \param H the heap we're working on
+ * \param i an item position in the heap
+ *
+ * Moves up an item at position i to its correct position. Works only
+ * when called from xbt_heap_push. Do not use otherwise.
+ */
+static void xbt_heap_increase_key(xbt_heap_t H, int i)
+{
+ xbt_heap_item_t items = H->items;
+ int p = PARENT(i);
+ while (i > 0 && items[p].key > items[i].key) {
+ struct xbt_heap_item tmp = items[i];
+ items[i] = items[p];
+ items[p] = tmp;
+ if (H->update_callback)
+ H->update_callback(items[i].content, i);
+ i = p;
+ p = PARENT(i);
+ }
+ if (H->update_callback)
+ H->update_callback(items[i].content, i);
+ return;
+}
