Merge branch 'blender2.7'
[blender.git] / source / blender / blenlib / BLI_heap_simple.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 #ifndef __BLI_HEAP_SIMPLE_H__
22 #define __BLI_HEAP_SIMPLE_H__
23
24 /** \file BLI_heap_simple.h
25  *  \ingroup bli
26  *  \brief A min-heap / priority queue ADT
27  */
28
29 struct HeapSimple;
30 typedef struct HeapSimple HeapSimple;
31
32 typedef void (*HeapSimpleFreeFP)(void *ptr);
33
34 HeapSimple *BLI_heapsimple_new_ex(unsigned int tot_reserve) ATTR_WARN_UNUSED_RESULT;
35 HeapSimple *BLI_heapsimple_new(void) ATTR_WARN_UNUSED_RESULT;
36 void        BLI_heapsimple_clear(HeapSimple *heap, HeapSimpleFreeFP ptrfreefp) ATTR_NONNULL(1);
37 void        BLI_heapsimple_free(HeapSimple *heap, HeapSimpleFreeFP ptrfreefp) ATTR_NONNULL(1);
38 void        BLI_heapsimple_insert(HeapSimple *heap, float value, void *ptr) ATTR_NONNULL(1);
39 bool        BLI_heapsimple_is_empty(const HeapSimple *heap) ATTR_NONNULL(1);
40 uint        BLI_heapsimple_len(const HeapSimple *heap) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
41 float       BLI_heapsimple_top_value(const HeapSimple *heap) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
42 void       *BLI_heapsimple_pop_min(HeapSimple *heap) ATTR_NONNULL(1);
43
44 #endif  /* __BLI_HEAP_SIMPLE_H__ */