src/heap.h

   1 /* heap.h - Abstract heap type
   2  * Copyright 2000-2001 srvx Development Team
   3  *
   4  * This file is part of srvx.
   5  *
   6  * srvx is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with srvx; if not, write to the Free Software Foundation,
  18  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
  19  */
  20
  21 #ifndef HEAP_H
  22 #define HEAP_H
  23
  24 typedef int (*comparator_f)(const void *a, const void *b);
  25
  26 /* a heap is implemented using a dynamically sized array */
  27 typedef struct heap *heap_t;
  28
  29 /* operations on a heap */
  30 heap_t heap_new(comparator_f comp);
  31 void heap_insert(heap_t heap, void *key, void *data);
  32 void heap_peek(heap_t heap, void **key, void **data);
  33 void heap_pop(heap_t heap);
  34 void heap_delete(heap_t heap);
  35 unsigned int heap_size(heap_t heap);
  36 int heap_remove_pred(heap_t heap, int (*pred)(void *key, void *data, void *extra), void *extra);
  37
  38 /* useful comparators */
  39
  40 /* int strcmp(const char *s1, const char *s2); from <string.h> can be used */
  41 int ulong_comparator(const void*, const void*);
  42
  43 #endif /* ndef HEAP_H */