src/heap.h

   1 /*!
   2  * \file src/heap.h
   3  *
   4  * \brief Prototypes for heap routines.
   5  *
   6  * This file, heap.h, was written and is
   7  *
   8  * Copyright (c) 2001 C. Scott Ananian
   9  *
  10  * <hr>
  11  *
  12  * <h1><b>Copyright.</b></h1>\n
  13  *
  14  * PCB, interactive printed circuit board design
  15  *
  16  * Copyright (C) 1994,1995,1996 Thomas Nau
  17  *
  18  * Copyright (C) 1998,1999,2000,2001 harry eaton
  19  *
  20  * This program is free software; you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation; either version 2 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program; if not, write to the Free Software
  32  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  33  *
  34  * Contact addresses for paper mail and Email:
  35  * harry eaton, 6697 Buttonhole Ct, Columbia, MD 21044 USA
  36  * haceaton@aplcomm.jhuapl.edu
  37  */
  38
  39 #ifndef PCB_HEAP_H
  40 #define PCB_HEAP_H
  41
  42 #include "global.h"
  43
  44 /*!
  45  * \brief Type of heap costs.
  46  */
  47 typedef double cost_t;
  48 /*!
  49  * \brief What a heap looks like.
  50  */
  51 typedef struct heap_struct heap_t;
  52
  53 heap_t *heap_create ();
  54 void heap_destroy (heap_t ** heap);
  55 void heap_free (heap_t * heap, void (*funcfree) (void *));
  56
  57 /* -- mutation -- */
  58 void heap_insert (heap_t * heap, cost_t cost, void *data);
  59 void *heap_remove_smallest (heap_t * heap);
  60 void *heap_replace (heap_t * heap, cost_t cost, void *data);
  61
  62 /* -- interrogation -- */
  63 int heap_is_empty (heap_t * heap);
  64 int heap_size (heap_t * heap);
  65
  66 #endif /* PCB_HEAP_H */