00001 /* -*- c-basic-offset: 4; indent-tabs-mode: nil -*- */ 00002 /* ==================================================================== 00003 * Copyright (c) 1999-2004 Carnegie Mellon University. All rights 00004 * reserved. 00005 * 00006 * Redistribution and use in source and binary forms, with or without 00007 * modification, are permitted provided that the following conditions 00008 * are met: 00009 * 00010 * 1. Redistributions of source code must retain the above copyright 00011 * notice, this list of conditions and the following disclaimer. 00012 * 00013 * 2. Redistributions in binary form must reproduce the above copyright 00014 * notice, this list of conditions and the following disclaimer in 00015 * the documentation and/or other materials provided with the 00016 * distribution. 00017 * 00018 * This work was supported in part by funding from the Defense Advanced 00019 * Research Projects Agency and the National Science Foundation of the 00020 * United States of America, and the CMU Sphinx Speech Consortium. 00021 * 00022 * THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND 00023 * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 00024 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 00025 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY 00026 * NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00027 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 00028 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 00029 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 00030 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 00031 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 00032 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00033 * 00034 * ==================================================================== 00035 * 00036 */ 00037 /* 00038 * heap.h -- Generic heap structure for inserting in any and popping in sorted 00039 * order. 00040 * 00041 * ********************************************** 00042 * CMU ARPA Speech Project 00043 * 00044 * Copyright (c) 1999 Carnegie Mellon University. 00045 * ALL RIGHTS RESERVED. 00046 * ********************************************** 00047 * 00048 * HISTORY 00049 * $Log: heap.h,v $ 00050 * Revision 1.7 2005/06/22 03:05:49 arthchan2003 00051 * 1, Fixed doxygen documentation, 2, Add keyword. 00052 * 00053 * Revision 1.4 2005/06/15 04:21:46 archan 00054 * 1, Fixed doxygen-documentation, 2, Add keyword such that changes will be logged into a file. 00055 * 00056 * Revision 1.3 2005/03/30 01:22:48 archan 00057 * Fixed mistakes in last updates. Add 00058 * 00059 * 00060 * 23-Dec-96 M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon University 00061 * Started. 00062 */ 00063 00064 00065 #ifndef _LIBUTIL_HEAP_H_ 00066 #define _LIBUTIL_HEAP_H_ 00067 00068 /* Win32/WinCE DLL gunk */ 00069 #include <sphinxbase_export.h> 00070 #include <prim_type.h> 00071 00083 #ifdef __cplusplus 00084 extern "C" { 00085 #endif 00086 #if 0 00087 /* Fool Emacs. */ 00088 } 00089 #endif 00090 00091 /* FIXME. This is dumb, it should use an opaque structure, at least 00092 * (and, that would still be binary compatible, too) */ 00093 typedef void *heap_t; 00094 00095 00096 00097 00101 SPHINXBASE_EXPORT 00102 heap_t heap_new ( void ); 00103 00104 00109 SPHINXBASE_EXPORT 00110 int32 heap_insert (heap_t heap, 00111 void *data, 00112 int32 val 00113 ); 00119 SPHINXBASE_EXPORT 00120 int32 heap_top (heap_t heap, 00121 void **data, 00122 int32 *val 00123 ); 00127 SPHINXBASE_EXPORT 00128 int32 heap_pop (heap_t heap, void **data, int32 *val); 00129 00133 SPHINXBASE_EXPORT 00134 int32 heap_size(heap_t heap); 00135 00141 SPHINXBASE_EXPORT 00142 int32 heap_destroy (heap_t heap); 00143 00144 #ifdef __cplusplus 00145 } 00146 #endif 00147 00148 #endif