diff options
Diffstat (limited to 'source/blender/blenlib/BLI_heap_simple.h')
| -rw-r--r-- | source/blender/blenlib/BLI_heap_simple.h | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/source/blender/blenlib/BLI_heap_simple.h b/source/blender/blenlib/BLI_heap_simple.h index b2a1b5582e5..5583f209de0 100644 --- a/source/blender/blenlib/BLI_heap_simple.h +++ b/source/blender/blenlib/BLI_heap_simple.h @@ -30,14 +30,29 @@ typedef struct HeapSimple HeapSimple; typedef void (*HeapSimpleFreeFP)(void *ptr); +/** + * Creates a new simple heap, which only supports insertion and removal from top. + * + * \note Use when the size of the heap is known in advance. + */ HeapSimple *BLI_heapsimple_new_ex(unsigned int tot_reserve) ATTR_WARN_UNUSED_RESULT; HeapSimple *BLI_heapsimple_new(void) ATTR_WARN_UNUSED_RESULT; void BLI_heapsimple_clear(HeapSimple *heap, HeapSimpleFreeFP ptrfreefp) ATTR_NONNULL(1); void BLI_heapsimple_free(HeapSimple *heap, HeapSimpleFreeFP ptrfreefp) ATTR_NONNULL(1); +/** + * Insert heap node with a value (often a 'cost') and pointer into the heap, + * duplicate values are allowed. + */ void BLI_heapsimple_insert(HeapSimple *heap, float value, void *ptr) ATTR_NONNULL(1); bool BLI_heapsimple_is_empty(const HeapSimple *heap) ATTR_NONNULL(1); uint BLI_heapsimple_len(const HeapSimple *heap) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1); +/** + * Return the lowest value of the heap. + */ float BLI_heapsimple_top_value(const HeapSimple *heap) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1); +/** + * Pop the top node off the heap and return its pointer. + */ void *BLI_heapsimple_pop_min(HeapSimple *heap) ATTR_NONNULL(1); #ifdef __cplusplus |