std::is_heap_until

C++ Reference
Language Concepts 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 is_partitioned (C++11) partition partition_copy (C++11) 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 > RandomAccessIterator is_heap_until( RandomAccessIterator first,                                     RandomAccessIterator last );	(1)	(since C++11)
template< class RandomAccessIterator, class Compare > RandomAccessIterator is_heap_until( RandomAccessIterator first,                                     RandomAccessIterator last,                                     Compare comp );	(2)	(since C++11)

Examines the range [first, last) and finds the largest range beginning at first which is heap. The first version of the function uses operator< to compare the elements, the second uses the given comparison function comp.

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: 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. ​

Return value

The upper bound of the largest range beginning at first which is heap. That is, the last iterator it for which range [first, it) is heap.

Complexity

linear in the distance between first and last

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.

See also

is_heap	checks if the given range is a heap (function template)