std::make_heap
| Defined in header <algorithm>
|
||
template< class RandomIt >
void make_heap( RandomIt first, RandomIt last );
|
(1) | (constexpr since C++20) |
template< class RandomIt, class Compare >
void make_heap( RandomIt first, RandomIt last, Compare comp );
|
(2) | (constexpr since C++20) |
Constructs a heap out of the target range [first, last).
operator<(until C++20)std::less{}(since C++20).comp.If any of the following conditions is satisfied, the behavior is undefined:
|
(until C++11) |
|
(since C++11) |
Parameters
| first, last | - | the pair of iterators defining the target range |
| 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:
While the signature does not need to have |
| Type requirements | ||
-RandomIt must meet the requirements of LegacyRandomAccessIterator.
| ||
-Compare must meet the requirements of Compare.
| ||
Complexity
Given N as std::distance(first, last):
operator<(until C++20)std::less{}(since C++20).comp.Example
#include <algorithm>
#include <functional>
#include <print>
#include <vector>
int main()
{
std::println("Max heap");
std::vector<int> v{3, 2, 4, 1, 5, 9};
std::println("initially: {}", v);
std::make_heap(v.begin(), v.end());
std::println("after make_heap: {}", v);
std::pop_heap(v.begin(), v.end());
std::println("after pop_heap: {}", v);
auto top = v.back();
v.pop_back();
std::println("former top element: {}", top);
std::println("after removing the former top element: {}\n", v);
std::println("Min heap");
std::vector<int> v1{3, 2, 4, 1, 5, 9};
std::println("initially: {}", v1);
std::make_heap(v1.begin(), v1.end(), std::greater<>{});
std::println("after make_heap: {}", v1);
std::pop_heap(v1.begin(), v1.end(), std::greater<>{});
std::println("after pop_heap: {}", v1);
auto top1 = v1.back();
v1.pop_back();
std::println("former top element: {}", top1);
std::println("after removing the former top element: {}", v1);
}
Output:
Max heap
initially: [3, 2, 4, 1, 5, 9]
after make_heap: [9, 5, 4, 1, 2, 3]
after pop_heap: [5, 3, 4, 1, 2, 9]
former top element: 9
after removing the former top element: [5, 3, 4, 1, 2]
Min heap
initially: [3, 2, 4, 1, 5, 9]
after make_heap: [1, 2, 4, 3, 5, 9]
after pop_heap: [2, 3, 4, 9, 5, 1]
former top element: 1
after removing the former top element: [2, 3, 4, 9, 5]
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 the target range was not required to be swappable | required |
See also
(C++20) |
creates a max heap out of a range of elements (algorithm function object) |
(C++11) |
checks if the given range is a max heap (function template & algorithm function object) |
(C++20) |
|
(C++11) |
finds the largest subrange that is a max heap (function template & algorithm function object) |
(C++20) |
|
| adds an element to a max heap (function template & algorithm function object) | |
(C++20) |
|
| removes the largest element from a max heap (function template & algorithm function object) | |
(C++20) |
|
| turns a max heap into a range of elements sorted in ascending order (function template & algorithm function object) | |
(C++20) |
|
| adapts a container to provide priority queue (class template) |