Template Function eastl::remove_heap(RandomAccessIterator, Distance, Distance)

Function Documentation

template<typename RandomAccessIterator, typename Distance>
void eastl::remove_heap(RandomAccessIterator first, Distance heapSize, Distance position)


Removes an arbitrary entry from the heap and adjusts the heap appropriately. This function is unlike pop_heap in that pop_heap moves the top item to the back of the heap, whereas remove_heap moves an arbitrary item to the back of the heap.

Note: Since this function moves the element to the back of the heap and doesn’t actually remove it from the given container, the user must call the container erase function if the user wants to erase the element from the container.