new function: remove a given element of the xbt_heap

[simgrid.git] / src / xbt / heap.c

diff --git a/src/xbt/heap.c b/src/xbt/heap.c
index 2b15380..f2f75ba 100644 (file)
--- a/src/xbt/heap.c
+++ b/src/xbt/heap.c
@@ -1,6 +1,6 @@
 /* a generic and efficient heap                                             */
 
-/* Copyright (c) 2004, 2005, 2007, 2008, 2009, 2010. The SimGrid Team.
+/* Copyright (c) 2004-2005, 2007-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -11,8 +11,9 @@
 #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_max_heapify(xbt_heap_t H, int i);
 static void xbt_heap_increase_key(xbt_heap_t H, int i);
 
 /** @addtogroup XBT_heap
@@ -95,7 +96,7 @@ void xbt_heap_push(xbt_heap_t H, void *content, double key)
   if (count > size) {
     H->size = (size << 1) + 1;
     H->items =
-        (void *) realloc(H->items,
+        (void *) xbt_realloc(H->items,
                          (H->size) * sizeof(struct xbt_heap_item));
   }
 
@@ -103,6 +104,7 @@ void xbt_heap_push(xbt_heap_t H, void *content, double key)
   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;
 }
 
@@ -124,15 +126,17 @@ void *xbt_heap_pop(xbt_heap_t H)
   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);
+  xbt_heap_max_heapify(H,0);
   if (H->count < size >> 2 && size > 16) {
     size = (size >> 1) + 1;
     H->items =
-        (void *) realloc(items,
+        (void *) xbt_realloc(items,
                          size * sizeof(struct xbt_heap_item));
     H->size = size;
   }
@@ -145,13 +149,15 @@ void *xbt_heap_pop(xbt_heap_t H)
 /**
  * @brief Extracts from the heap and returns the element at position i.
  * \param H the heap we're working on
- * \param i    element position
+ * \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 */
@@ -162,6 +168,43 @@ void *xbt_heap_remove(xbt_heap_t H, int i)
 
   return xbt_heap_pop(H);
 }
+/** @brief Remove an arbitrary element from 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
+ */
+void xbt_heap_rm_elm(xbt_heap_t H, void *content, double key) {
+       int i=0;
+       while (i < H->count && (KEY(H, i) != key || CONTENT(H, i) != content))
+               i++;
+       if (i == H->count)
+               return;
+       xbt_heap_remove(H,i);
+}
+
+/**
+ * @brief Updates an element of the heap with a new value.
+ * \param H the heap we're working on
+ * \param i  element position
+ * \param key new value for the element
+ *
+ * Updates an element of the heap with a new value.
+ */
+void xbt_heap_update(xbt_heap_t H, int i, double key)
+{
+  XBT_DEBUG("Heap has %d elements: updating element %d : was %1.12f to %1.12f ",xbt_heap_size(H),i,KEY(H, i), key);
+
+  if ((i < 0) || (i > H->count - 1) || key == KEY(H, i))
+    return ;
+
+  if(key< KEY(H, i)){
+    KEY(H, i)=key;
+    xbt_heap_increase_key(H, i);
+  }else{
+    KEY(H, i)=key;
+    xbt_heap_max_heapify(H,i);
+  }
+}
 
 /**
  * @brief returns the smallest key in the heap (heap unchanged)
@@ -193,9 +236,9 @@ void *xbt_heap_maxcontent(xbt_heap_t H)
  *
  * Restores the heap property once an element has been deleted.
  */
-static void xbt_heap_max_heapify(xbt_heap_t H)
+static void xbt_heap_max_heapify(xbt_heap_t H, int index)
 {
-  int i = 0;
+  int i = index;
   int count = H->count;
   xbt_heap_item_t items = H->items;