c0941e00c9b1b0bef6975edeb033babb7a95c77a
[blender.git] / source / blender / blenlib / BLI_heap.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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: none of this file.
22  *
23  * Contributor(s): Brecht Van Lommel
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27  
28 #ifndef __BLI_HEAP_H__
29 #define __BLI_HEAP_H__
30
31 /** \file BLI_heap.h
32  *  \ingroup bli
33  *  \brief A heap / priority queue ADT
34  */
35
36 struct Heap;
37 struct HeapNode;
38 typedef struct Heap Heap;
39 typedef struct HeapNode HeapNode;
40
41 typedef void (*HeapFreeFP)(void *ptr);
42
43 /* Creates a new heap. BLI_memarena is used for allocating nodes. Removed nodes
44  * are recycled, so memory usage will not shrink. */
45 Heap           *BLI_heap_new_ex(unsigned int tot_reserve);
46 Heap           *BLI_heap_new(void);
47 void            BLI_heap_free(Heap *heap, HeapFreeFP ptrfreefp);
48
49 /* Insert heap node with a value (often a 'cost') and pointer into the heap,
50  * duplicate values are allowed. */
51 HeapNode       *BLI_heap_insert(Heap *heap, float value, void *ptr);
52
53 /* Remove a heap node. */
54 void            BLI_heap_remove(Heap *heap, HeapNode *node);
55
56 /* Return 0 if the heap is empty, 1 otherwise. */
57 int             BLI_heap_is_empty(Heap *heap);
58
59 /* Return the size of the heap. */
60 unsigned int    BLI_heap_size(Heap *heap);
61
62 /* Return the top node of the heap. This is the node with the lowest value. */
63 HeapNode       *BLI_heap_top(Heap *heap);
64
65 /* Pop the top node off the heap and return it's pointer. */
66 void           *BLI_heap_popmin(Heap *heap);
67
68 /* Return the value or pointer of a heap node. */
69 float           BLI_heap_node_value(HeapNode *heap);
70 void           *BLI_heap_node_ptr(HeapNode *heap);
71
72 #endif  /* __BLI_HEAP_H__ */