BLI_heap: add an API function to directly read the top node value.

It is very commonly needed in loop conditions to check if
the items in the heap are good enough to continue.

1 files changed, 11 insertions, 0 deletions

diff --git a/source/blender/blenlib/intern/BLI_heap.c b/source/blender/blenlib/intern/BLI_heap.c
index 5658c1fd103..17a15f93266 100644
--- a/source/blender/blenlib/intern/BLI_heap.c
+++ b/source/blender/blenlib/intern/BLI_heap.c
@@ -318,6 +318,17 @@ HeapNode *BLI_heap_top(const Heap *heap)
 }
 
 /**
+ * Return the value of top node of the heap.
+ * This is the node with the lowest value.
+ */
+float BLI_heap_top_value(const Heap *heap)
+{
+	BLI_assert(heap->size != 0);
+
+	return heap->tree[0]->value;
+}
+
+/**
  * Pop the top node off the heap and return it's pointer.
  */
 void *BLI_heap_pop_min(Heap *heap)