Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext
pop_heap
Prototype

template<class RandomAccessRange>
RandomAccessRange& pop_heap(RandomAccessRange& rng);

template<class RandomAccessRange>
const RandomAccessRange& pop_heap(const RandomAccessRange& rng);

template<class RandomAccessRange, class Compare>
RandomAccessRange& pop_heap(RandomAccessRange& rng, Compare pred);

template<class RandomAccessRange, class Compare>
const RandomAccessRange& pop_heap(const RandomAccessRange& rng, Compare pred);

Description

pop_heap removes the largest element from the heap. It is assumed that begin(rng), prior(end(rng)) is already a heap (and therefore the largest element is *begin(rng)).

The ordering relationship is determined by using operator< in the non-predicate versions, and by evaluating pred in the predicate versions.

Definition

Defined in the header file boost/range/algorithm/heap_algorithm.hpp

Requirements

For the non-predicate versions:

For the predicate versions:

Precondition:
Complexity

Logarithmic. At most 2 * log(distance(rng)) comparisons.


PrevUpHomeNext