std::push_heap
Defined in header <algorithm>
|
||
template< class RandomIt > void push_heap( RandomIt first, RandomIt last ); |
(1) | (constexpr since C++20) |
template< class RandomIt, class Compare > void push_heap( RandomIt first, RandomIt last, Compare comp ); |
(2) | (constexpr since C++20) |
Inserts the element at the position last - 1 into the heap [
first,
last - 1)
. The heap after the insertion will be [
first,
last)
.
If any of the following conditions is satisfied, the behavior is undefined:
-
[
first,
last - 1)
is not a heap.
|
(until C++11) |
|
(since C++11) |
Contents |
[edit] Parameters
first, last | - | the range indicating the heap after the insertion |
comp | - | comparison function object (i.e. an object that satisfies the requirements of Compare) 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); While the signature does not need to have const&, the function must not modify the objects passed to it and must be able to accept all values of type (possibly const) |
Type requirements | ||
-RandomIt must meet the requirements of LegacyRandomAccessIterator.
| ||
-Compare must meet the requirements of Compare.
|
[edit] Complexity
Given N as std::distance(first, last):
[edit] Example
#include <algorithm> #include <iostream> #include <string_view> #include <vector> void println(std::string_view rem, const std::vector<int>& v) { std::cout << rem; for (int e : v) std::cout << e << ' '; std::cout << '\n'; } int main() { std::vector<int> v{3, 1, 4, 1, 5, 9}; std::make_heap(v.begin(), v.end()); println("after make_heap: ", v); v.push_back(6); println("after push_back: ", v); std::push_heap(v.begin(), v.end()); println("after push_heap: ", v); }
Output:
after make_heap: 9 5 4 1 1 3 after push_back: 9 5 4 1 1 3 6 after push_heap: 9 5 6 1 1 3 4
[edit] Defect reports
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
DR | Applied to | Behavior as published | Correct behavior |
---|---|---|---|
LWG 3032 | C++98 | the elements of [ first, last) was not required to be swappable
|
required |
[edit] See also
(C++11) |
checks if the given range is a max heap (function template) |
(C++11) |
finds the largest subrange that is a max heap (function template) |
creates a max heap out of a range of elements (function template) | |
removes the largest element from a max heap (function template) | |
turns a max heap into a range of elements sorted in ascending order (function template) | |
(C++20) |
adds an element to a max heap (niebloid) |