void* pblHeapRemoveFirst

( PblHeap* heap )

Removes the biggest element from the heap, maintaining the heap condition of the heap.

Documentation

Removes the biggest element from the heap, maintaining the heap condition of the heap.

This function has a time complexity of O(Log N), with N being the number of elements in the heap.

Parameters:

heap - The heap to use

Returns:

void* retptr != (void*)-1: The element removed.
void* retptr == (void*)-1: An error see pbl_errno:
PBL_ERROR_OUT_OF_BOUNDS - The heap is empty.

Alphabetic index