std::is_heap
From Cppreference
Defined in header <algorithm>
|
||
template< class RandomAccessIterator >
bool is_heap( RandomAccessIterator first, RandomAccessIterator last ); |
(1) | |
template< class RandomAccessIterator, class Compare >
bool is_heap( RandomAccessIterator first, RandomAccessIterator last, Compare comp ); |
(2) | |
Checks if the elements in range [first, last) is a heap. 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 to examine | |||||||||
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:
The signature does not need to have const &, but the function must not modify the objects passed to it. |
[edit] Return value
true if the range is heap, false otherwise.
[edit] Complexity
linear in the distance between first and 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
This section is incomplete |
[edit] See also
|
finds the largest subrange that is heap (function template) |