src/heap.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  18    02111-1307, USA. */
  19
  20 #if !heap_h
  21 #define heap_h 1
  22
  23 /* This module implements a priority queue as a heap as described in
  24    Knuth 5.2.3.  This is a first-in-smallest-out priority queue. */
  25
  26 #include <stddef.h>
  27
  28 /* One element of a heap. */
  29 struct heap_elem
  30   {
  31     int index;                  /* Data. */
  32     int key;                    /* Key value. */
  33   };
  34
  35 /* An entire heap. */
  36 struct heap
  37   {
  38     size_t n_elem;              /* Number of elements in heap. */
  39     size_t m_elem;              /* Number of elements allocated for heap. */
  40     struct heap_elem *elem;     /* Heap elements. */
  41   };
  42
  43 struct heap *heap_create (size_t m_elem);
  44 void heap_destroy (struct heap *);
  45 int heap_insert (struct heap *, int index, int key);
  46 int heap_delete (struct heap *, int *key);
  47 int heap_size (struct heap *);
  48
  49 #if GLOBAL_DEBUGGING
  50 void heap_verify (const struct heap *);
  51 void heap_dump (const struct heap *);
  52 #endif
  53
  54 #endif /* heap_h */