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

Function Documentation

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

remove_heap

The Compare function must work equivalently to the compare function used to make and maintain 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.