SphinxBase 5prealpha
heap.h
Go to the documentation of this file.
1/* -*- c-basic-offset: 4; indent-tabs-mode: nil -*- */
2/* ====================================================================
3 * Copyright (c) 1999-2004 Carnegie Mellon University. All rights
4 * 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
15 * the documentation and/or other materials provided with the
16 * distribution.
17 *
18 * This work was supported in part by funding from the Defense Advanced
19 * Research Projects Agency and the National Science Foundation of the
20 * United States of America, and the CMU Sphinx Speech Consortium.
21 *
22 * THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND
23 * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
24 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY
26 * NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 * ====================================================================
35 *
36 */
37/*
38 * heap.h -- Generic heap structure for inserting in any and popping in sorted
39 * order.
40 *
41 * **********************************************
42 * CMU ARPA Speech Project
43 *
44 * Copyright (c) 1999 Carnegie Mellon University.
45 * ALL RIGHTS RESERVED.
46 * **********************************************
47 *
48 * HISTORY
49 * $Log: heap.h,v $
50 * Revision 1.7 2005/06/22 03:05:49 arthchan2003
51 * 1, Fixed doxygen documentation, 2, Add keyword.
52 *
53 * Revision 1.4 2005/06/15 04:21:46 archan
54 * 1, Fixed doxygen-documentation, 2, Add keyword such that changes will be logged into a file.
55 *
56 * Revision 1.3 2005/03/30 01:22:48 archan
57 * Fixed mistakes in last updates. Add
58 *
59 *
60 * 23-Dec-96 M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon University
61 * Started.
62 */
63
64
65#ifndef _LIBUTIL_HEAP_H_
66#define _LIBUTIL_HEAP_H_
67
68#include <stdlib.h>
69
70/* Win32/WinCE DLL gunk */
71#include <sphinxbase/sphinxbase_export.h>
73
85#ifdef __cplusplus
86extern "C" {
87#endif
88#if 0
89/* Fool Emacs. */
90}
91#endif
92
93
94typedef struct heap_s heap_t;
95
96
100SPHINXBASE_EXPORT
101heap_t *heap_new(void);
102
103
108SPHINXBASE_EXPORT
109int heap_insert(heap_t *heap,
110 void *data,
111 int32 val
112 );
118SPHINXBASE_EXPORT
119int heap_top(heap_t *heap,
120 void **data,
121 int32 *val
122 );
126SPHINXBASE_EXPORT
127int heap_pop(heap_t *heap, void **data, int32 *val);
128
132SPHINXBASE_EXPORT
133int heap_remove(heap_t *heap, void *data);
134
138SPHINXBASE_EXPORT
139size_t heap_size(heap_t *heap);
140
146SPHINXBASE_EXPORT
147int heap_destroy(heap_t *heap);
148
149#ifdef __cplusplus
150}
151#endif
152
153#endif
SPHINXBASE_EXPORT size_t heap_size(heap_t *heap)
Return the number of items in the heap.
Definition: heap.c:273
SPHINXBASE_EXPORT int heap_pop(heap_t *heap, void **data, int32 *val)
Like heap_top but also pop the top item off the heap.
Definition: heap.c:209
SPHINXBASE_EXPORT heap_t * heap_new(void)
Allocate a new heap and return handle to it.
Definition: heap.c:113
SPHINXBASE_EXPORT int heap_insert(heap_t *heap, void *data, int32 val)
Insert a new item into the given heap.
Definition: heap.c:161
SPHINXBASE_EXPORT int heap_remove(heap_t *heap, void *data)
Remove an item from the heap.
Definition: heap.c:266
SPHINXBASE_EXPORT int heap_destroy(heap_t *heap)
Destroy the given heap; free the heap nodes.
Definition: heap.c:281
SPHINXBASE_EXPORT int heap_top(heap_t *heap, void **data, int32 *val)
Return the topmost item in the heap.
Definition: heap.c:221
Basic type definitions used in Sphinx.
Internal heap data structure.
Definition: heap.c:89