src/heap.c

Go to the documentation of this file.

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "global.h"

#include <assert.h>

#include "heap.h"

#ifdef HAVE_LIBDMALLOC
#include <dmalloc.h>
#endif

/* define this for more thorough self-checking of data structures */
#undef SLOW_ASSERTIONS

/* ---------------------------------------------------------------------------
 * some local prototypes
 */

/* ---------------------------------------------------------------------------
 * some local types
 */
struct heap_element
{
  cost_t cost;
  void *data;
};
struct heap_struct
{
  struct heap_element *element;
  int size, max;
};

/* ---------------------------------------------------------------------------
 * some local identifiers
 */
static cost_t MIN_COST = 0;

/* ---------------------------------------------------------------------------
 * functions.
 */
/* helper functions for assertions */
#ifndef NDEBUG
#ifdef SLOW_ASSERTIONS
static int
__heap_is_good_slow (heap_t * heap)
{
  int i;
  /* heap condition: key in each node should be smaller than in its children */
  /* alternatively (and this is what we check): key in each node should be
   * larger than (or equal to) key of its parent. */
  /* note that array element[0] is not used (except as a sentinel) */
  for (i = 2; i < heap->size; i++)
    if (heap->element[i].cost < heap->element[i / 2].cost)
      return 0;
  return 1;
}
#endif /* SLOW_ASSERTIONS */
static int
__heap_is_good (heap_t * heap)
{
  return heap && (heap->max == 0 || heap->element) &&
    (heap->max >= 0) && (heap->size >= 0) &&
    (heap->max == 0 || heap->size < heap->max) &&
#ifdef SLOW_ASSERTIONS
    __heap_is_good_slow (heap) &&
#endif
    1;
}
#endif /* ! NDEBUG */

heap_t *
heap_create ()
{
  heap_t *heap;
  /* initialize MIN_COST if necessary */
  if (MIN_COST == 0)
    MIN_COST = -1e23;
  assert (MIN_COST < 0);
  /* okay, create empty heap */
  heap = (heap_t *)calloc (1, sizeof (*heap));
  assert (heap);
  assert (__heap_is_good (heap));
  return heap;
}

void
heap_destroy (heap_t ** heap)
{
  assert (heap && *heap);
  assert (__heap_is_good (*heap));
  if ((*heap)->element)
    free ((*heap)->element);
  free (*heap);
  *heap = NULL;
}

void heap_free (heap_t *heap, void (*freefunc) (void *))
{
  assert (heap);
  assert (__heap_is_good (heap));
  for ( ; heap->size; heap->size--)  
   {
     if (heap->element[heap->size].data)
       freefunc (heap->element[heap->size].data);
   }
}

/* -- mutation -- */

static void
__upheap (heap_t * heap, int k)
{
  struct heap_element v;

  assert (heap && heap->size < heap->max);
  assert (k <= heap->size);

  heap->element[0].cost = MIN_COST;
  for (v = heap->element[k]; heap->element[k / 2].cost > v.cost; k = k / 2)
    heap->element[k] = heap->element[k / 2];
  heap->element[k] = v;
}

void
heap_insert (heap_t * heap, cost_t cost, void *data)
{
  assert (heap && __heap_is_good (heap));
  assert (cost >= MIN_COST);

  /* determine whether we need to grow the heap */
  if (heap->size + 1 >= heap->max)
    {
      heap->max *= 2;
      if (heap->max == 0)
        heap->max = 256;                /* default initial heap size */
      heap->element =
        (struct heap_element *)realloc (heap->element, heap->max * sizeof (*heap->element));
    }
  heap->size++;
  assert (heap->size < heap->max);
  heap->element[heap->size].cost = cost;
  heap->element[heap->size].data = data;
  __upheap (heap, heap->size);  /* fix heap condition violation */
  assert (__heap_is_good (heap));
  return;
}

static void
__downheap (heap_t * heap, int k)
{
  struct heap_element v;

  assert (heap && heap->size < heap->max);
  assert (k <= heap->size);

  v = heap->element[k];
  while (k <= heap->size / 2)
    {
      int j = k + k;
      if (j < heap->size && heap->element[j].cost > heap->element[j + 1].cost)
        j++;
      if (v.cost < heap->element[j].cost)
        break;
      heap->element[k] = heap->element[j];
      k = j;
    }
  heap->element[k] = v;
}

void *
heap_remove_smallest (heap_t * heap)
{
  struct heap_element v;
  assert (heap && __heap_is_good (heap));
  assert (heap->size > 0);
  assert (heap->max > 1);

  v = heap->element[1];
  heap->element[1] = heap->element[heap->size--];
  if (heap->size > 0)
    __downheap (heap, 1);

  assert (__heap_is_good (heap));
  return v.data;
}

void *
heap_replace (heap_t * heap, cost_t cost, void *data)
{
  assert (heap && __heap_is_good (heap));

  if (heap_is_empty (heap))
    return data;

  assert (heap->size > 0);
  assert (heap->max > 1);

  heap->element[0].cost = cost;
  heap->element[0].data = data;
  __downheap (heap, 0);         /* ooh, tricky! */

  assert (__heap_is_good (heap));
  return heap->element[0].data;
}

/* -- interrogation -- */

int
heap_is_empty (heap_t * heap)
{
  assert (__heap_is_good (heap));
  return heap->size == 0;
}

/* -- size -- */

int
heap_size (heap_t * heap)
{
  assert (__heap_is_good (heap));
  return heap->size;
}