binary-heap.h

Go to the documentation of this file.

/*
 
Copyright (c) 2005-2008, Simon Howard
 
Permission to use, copy, modify, and/or distribute this software 
for any purpose with or without fee is hereby granted, provided 
that the above copyright notice and this permission notice appear 
in all copies. 
 
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 
AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR 
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, 
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN      
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 
 
 */

 
#ifndef ALGORITHM_BINARY_HEAP_H
#define ALGORITHM_BINARY_HEAP_H
 
#ifdef __cplusplus
extern "C" {
#endif

 
typedef enum {
 
    BINARY_HEAP_TYPE_MIN,

 
    BINARY_HEAP_TYPE_MAX
} BinaryHeapType;

 
typedef void *BinaryHeapValue;

 
#define BINARY_HEAP_NULL ((void *) 0)

 
typedef int (*BinaryHeapCompareFunc)(BinaryHeapValue value1,
                                     BinaryHeapValue value2);

 
typedef struct _BinaryHeap BinaryHeap;

 
BinaryHeap *binary_heap_new(BinaryHeapType heap_type,
                            BinaryHeapCompareFunc compare_func);

 
void binary_heap_free(BinaryHeap *heap);

 
int binary_heap_insert(BinaryHeap *heap, BinaryHeapValue value);

 
BinaryHeapValue binary_heap_pop(BinaryHeap *heap);

 
int binary_heap_num_entries(BinaryHeap *heap);
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef ALGORITHM_BINARY_HEAP_H */