util/heap.h

   1 /*
   2  * Copyright (c) 1998 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /*
  35  * an abstract heap implementation
  36  */
  37
  38 /* $Id$ */
  39
  40 #ifndef _ARLAUTIL_HEAP_H
  41 #define _ARLAUTIL_HEAP_H 1
  42
  43 #include "bool.h"
  44
  45 typedef int (*heap_cmp_fn)(const void *, const void *);
  46
  47 typedef unsigned heap_ptr;
  48
  49 struct heap_element {
  50     const void *data;
  51     heap_ptr *ptr;
  52 };
  53
  54 typedef struct heap_element heap_element;
  55
  56 struct heap {
  57     heap_cmp_fn cmp;
  58     unsigned max_sz;
  59     unsigned sz;
  60     heap_element *data;
  61 };
  62
  63 typedef struct heap Heap;
  64
  65 Heap *heap_new (unsigned sz, heap_cmp_fn cmp);
  66
  67 int
  68 heap_insert (Heap *h, const void *data, heap_ptr *ptr);
  69
  70 const void *
  71 heap_head (Heap *h);
  72
  73 void
  74 heap_remove_head (Heap *h);
  75
  76 int
  77 heap_remove (Heap *h, heap_ptr ptr);
  78
  79 void
  80 heap_delete (Heap *h);
  81
  82 Bool
  83 heap_verify (Heap *h);
  84
  85 #endif /* _ARLAUTIL_HEAP_H */