std::push_heap

From Cppreference

Jump to: navigation, search
Defined in header <algorithm>

template< class RandomAccessIterator >
void push_heap( RandomAccessIterator first, RandomAccessIterator last );
(1)
template< class RandomAccessIterator, class Compare >

void push_heap( RandomAccessIterator first, RandomAccessIterator last,

                Compare comp );
(2)

Inserts the element at the position last-1 into the heap defined by the range [first, last-1). The first version of the function uses operator< to compare the elements, the second uses the given comparison function comp.

Contents

[edit] Parameters

first, last - the range of elements defining the heap to modify
comp - comparison function which returns ​true if the first argument is less than the second.

The signature of the comparison function should be equivalent to the following:

bool cmp(const Type1 &a, const Type2 &b);

The signature does not need to have const &, but the function must not modify the objects passed to it.
The types Type1 and Type2 must be such that an object of type RandomAccessIterator can be dereferenced and then implicitly converted to both of them. ​

[edit] Return value

(none)

[edit] Complexity

At most 2×log(N) comparisons where N=std::distance(first, last).

[edit] Notes

A heap is a range of elements [f,l) that has the following properties:

  • *f is the largest element in the range
  • a new element can be added using std::push_heap()
  • the first element can be removed using std::pop_heap()

The actual arrangement of the elements is implementation defined.

[edit] Example

[edit] See also

pop_heap
removes the largest element from a heap
(function template)