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