std::push_heap

From Cppreference

C++ Standard Library
Language Utilities library Strings library Containers library Algorithms library Iterators library Numerics library Input/output library Localizations library Regular expressions library (C++11) Atomic operations library (C++11) Thread support library (C++11)
Algorithm library
Functions Non-modifying sequence operations all_of any_of none_of (C++11) (C++11) (C++11) for_each count count_if mismatch equal find find_if find_if_not (C++11) find_end find_first_of adjacent_find search search_n Modifying sequence operations copy copy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) fill fill_n transform generate generate_n remove remove_if remove_copy remove_copy_if replace replace_if replace_copy replace_copy_if swap swap_ranges iter_swap reverse reverse_copy rotate rotate_copy random_shuffle shuffle   (C++11) unique unique_copy Partitioning operations partition (C++11) partition stable_partition partition_point (C++11) Sorting operations (on sorted ranges) is_sorted (C++11) is_sorted_until (C++11) sort partial_sort partial_sort_copy stable_sort nth_element Binary search operations (on sorted ranges) lower_bound upper_bound binary_search equal_range Set operations (on sorted ranges) merge inplace_merge includes set_difference set_intersection set_symmetric_difference set_union Heap operations is_heap is_heap_until (C++11) make_heap push_heap pop_heap sort_heap Minimum/maximum operations max max_element min min_element minmax (C++11) minmax_element (C++11) lexicographical_compare is_permutation (C++11) next_permutation prev_permutation Numeric operations iota (C++11) accumulate inner_product adjacent_difference partial_sum C library qsort bsearch

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 1 Parameters 2 Return value 3 Example 4 Complexity 5 Notes 6 See also

[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] Example

This section is incomplete

[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 push_heap()
• the first element can be removed using pop_heap()

The actual arrangement of the elements is implementation defined.

[edit] See also

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