src/xbt/heap.c

   1 /*      $Id$     */
   2
   3 /* a generic and efficient heap                                             */
   4
   5 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
   6
   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. */
   9
  10 #include "xbt/sysdep.h"
  11 #include "xbt/error.h"
  12 #include "heap_private.h"
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(heap,xbt,"Heap");
  14
  15 /**
  16  * xbt_heap_new:
  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).
  20  *
  21  * Creates a new heap.
  22  */
  23 xbt_heap_t xbt_heap_new(int init_size, void_f_pvoid_t * const free_func)
  24 {
  25   xbt_heap_t H = xbt_new0(struct xbt_heap, 1);
  26   H->size = init_size;
  27   H->count = 0;
  28   H->items = (xbt_heapItem_t) xbt_new0(struct xbt_heapItem, init_size);
  29   H->free = free_func;
  30   return H;
  31 }
  32
  33 /**
  34  * xbt_heap_free:
  35  * @H: poor victim
  36  *
  37  * kilkil a heap and its content
  38  */
  39 void xbt_heap_free(xbt_heap_t H)
  40 {
  41   int i;
  42   if (H->free)
  43     for (i = 0; i < H->count; i++)
  44       H->free(H->items[i].content);
  45   xbt_free(H->items);
  46   xbt_free(H);
  47   return;
  48 }
  49
  50 /**
  51  * xbt_heap_size:
  52  * @H: the heap we're working on
  53  *
  54  * returns the number of elements in the heap
  55  */
  56 int xbt_heap_size(xbt_heap_t H)
  57 {
  58   return (H->count);
  59 }
  60
  61 /**
  62  * xbt_heap_push:
  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
  66  *
  67  * Add an element int the heap. The element with the smallest key is
  68  * automatically moved at the top of the heap.
  69  */
  70 void xbt_heap_push(xbt_heap_t H, void *content, xbt_heap_float_t key)
  71 {
  72   int count = ++(H->count);
  73   int size = H->size;
  74   xbt_heapItem_t item;
  75   if (count > size) {
  76     H->size = 2 * size + 1;
  77     H->items =
  78         (void *) realloc(H->items,
  79                          (H->size) * sizeof(struct xbt_heapItem));
  80   }
  81   item = &(H->items[count - 1]);
  82   item->key = key;
  83   item->content = content;
  84   xbt_heap_increaseKey(H, count - 1);
  85   return;
  86 }
  87
  88 /**
  89  * xbt_heap_pop:
  90  * @H: the heap we're working on
  91  *
  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.
  95  */
  96 void *xbt_heap_pop(xbt_heap_t H)
  97 {
  98   void *max ;
  99
 100   if(H->count==0) return NULL;
 101
 102   max = CONTENT(H, 0);
 103
 104   H->items[0] = H->items[(H->count) - 1];
 105   (H->count)--;
 106   xbt_heap_maxHeapify(H);
 107   if (H->count < H->size / 4 && H->size > 16) {
 108     H->size = H->size / 2 + 1;
 109     H->items =
 110         (void *) realloc(H->items,
 111                          (H->size) * sizeof(struct xbt_heapItem));
 112   }
 113   return max;
 114 }
 115
 116 /**
 117  * xbt_heap_maxkey:
 118  * @H: the heap we're working on
 119  *
 120  * Returns the smallest key in the heap without modifying the heap.
 121  */
 122 xbt_heap_float_t xbt_heap_maxkey(xbt_heap_t H)
 123 {
 124   if(H->count==0) abort();
 125   return KEY(H, 0);
 126 }
 127
 128 /**
 129  * xbt_heap_maxcontent:
 130  * @H: the heap we're working on
 131  *
 132  * Returns the value associated to the smallest key in the heap
 133  * without modifying the heap.
 134  */
 135 void *xbt_heap_maxcontent(xbt_heap_t H)
 136 {
 137   if(H->count==0) abort();
 138   return CONTENT(H, 0);
 139 }
 140
 141 /**
 142  * xbt_heap_maxcontent:
 143  * @H: the heap we're working on
 144  *
 145  * Restores the heap property once an element has been deleted.
 146  */
 147 static void xbt_heap_maxHeapify(xbt_heap_t H)
 148 {
 149   int i = 0;
 150   while (1) {
 151     int greatest = i;
 152     int l = LEFT(i);
 153     int r = RIGHT(i);
 154     int count = H->count;
 155     if (l < count && KEY(H, l) < KEY(H, i))
 156       greatest = l;
 157     if (r < count && KEY(H, r) < KEY(H, greatest))
 158       greatest = r;
 159     if (greatest != i) {
 160       struct xbt_heapItem tmp = H->items[i];
 161       H->items[i] = H->items[greatest];
 162       H->items[greatest] = tmp;
 163       i = greatest;
 164     } else
 165       return;
 166   }
 167 }
 168
 169 /**
 170  * xbt_heap_maxcontent:
 171  * @H: the heap we're working on
 172  * @i: an item position in the heap
 173  *
 174  * Moves up an item at position i to its correct position. Works only
 175  * when called from xbt_heap_push. Do not use otherwise.
 176  */
 177 static void xbt_heap_increaseKey(xbt_heap_t H, int i)
 178 {
 179   while (i > 0 && KEY(H, PARENT(i)) > KEY(H, i)) {
 180     struct xbt_heapItem tmp = H->items[i];
 181     H->items[i] = H->items[PARENT(i)];
 182     H->items[PARENT(i)] = tmp;
 183     i = PARENT(i);
 184   }
 185   return;
 186 }