std::is_heap_until

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++0x feature) Atomic operations library (C++0x feature) Thread support library (C++0x feature)
Algorithm library
Functions Non-modifying sequence operations all_of any_of none_of (C++0x) (C++0x) (C++0x) for_each count count_if mismatch equal find find_if find_if_not (C++0x) find_end find_first_of adjacent_find search search_n Modifying sequence operations copy copy_backward 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 partition stable_partition reverse reverse_copy rotate rotate_copy random_shuffle unique unique_copy Sorting operations (on sorted ranges) is_sorted (C++0x) is_sorted_until (C++0x) 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++0x) make_heap push_heap pop_heap sort_heap Minimum/maximum operations max max_element min min_element lexicographical_compare next_permutation prev_permutation Numeric operations 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)	(C++0x feature)
​template< class RandomAccessIterator, class Compare > RandomAccessIterator is_heap_until( RandomAccessIterator first,                                     RandomAccessIterator last,                                     Compare comp );​	(2)	(C++0x feature)

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.

Contents 1 Parameters 2 Return value 3 Complexity 4 Example 5 Notes 6 See also

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 {{tt|it}] for which range [first, it) is heap.

Complexity

linear in the distance between first and last

Example

This section is incomplete

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.

See also

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