std::is_heap_until

Определён в заголовочном файле `<algorithm>`
template< class RandomIt > RandomIt is_heap_until( RandomIt first, RandomIt last );	(1)	(с C++11) (constexpr с C++20)
template< class ExecutionPolicy, class RandomIt > RandomIt is_heap_until( ExecutionPolicy&& policy, RandomIt first, RandomIt last );	(2)	(с C++17)
template< class RandomIt, class Compare > RandomIt is_heap_until( RandomIt first, RandomIt last, Compare comp );	(3)	(с C++11) (constexpr с C++20)
template< class ExecutionPolicy, class RandomIt, class Compare > RandomIt is_heap_until( ExecutionPolicy&& policy, RandomIt first, RandomIt last, Compare comp );	(4)	(с C++17)

Проверяет диапазон [first, last) и находит наибольший диапазон, начинающийся с first, который является кучей.

1) Свойство кучи проверяется относительно operator<(до C++20)std::less{}(с C++20).

3) Свойство кучи проверяется относительно comp.

2,4) То же, что и (1,3), но выполняется в соответствии с policy.

Эти перегрузки участвуют в разрешении перегрузки только в том случае, если значение следующего выражения равно true:

`std::is_execution_policy_v<std::decay_t<ExecutionPolicy>>`	(до C++20)
`std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>>`	(с C++20)

Параметры

first, last	-	пара итераторов, задающих диапазон проверяемых элементов
policy	-	политика выполнения, используемая алгоритмом
comp	-	объект функции сравнения (то есть объект, удовлетворяющий требованиям Compare), который возвращает `true`, если первый аргумент меньше второго. Сигнатура функции сравнения должна быть эквивалентна следующей: boolcmp(constType1&a,constType2&b); Хотя сигнатура не обязательно должна содержать `const&`, функция не должна изменять переданные ей объекты и должна принимать любые значения типа (возможно, const) `Type1` и `Type2` независимо от категории значения (таким образом, `Type1&` не допускается, как и `Type1`, за исключением случая, когда для `Type1` перемещение эквивалентно копированию(с C++11)). Типы Type1 и Type2 должны быть такими, чтобы объект типа RandomIt можно было разыменовать, а полученное значение неявно преобразовать к каждому из этих типов.
Требования к типам
-`RandomIt` должен соответствовать требованиям LegacyRandomAccessIterator.
-`Compare` должен соответствовать требованиям Compare.

Возвращаемое значение

Последний итератор it, для которого диапазон [first, it) является кучей.

Сложность

Пусть \(\scriptsize N\)N — std::distance(first, last):

1,2) \(\scriptsize O(N)\)O(N) сравнений с использованием operator<(до C++20)std::less{}(с C++20).

3,4) \(\scriptsize O(N)\)O(N) вызовов функции сравнения comp.

Исключения

Перегрузки с параметром шаблона с именем ExecutionPolicy сообщают об ошибках следующим образом:

Если выполнение функции, вызванной в рамках алгоритма, приводит к выбрасыванию исключения и ExecutionPolicy является одной из стандартных политик, вызывается std::terminate. Для любой другой ExecutionPolicy поведение определяется реализацией.
Если алгоритму не удаётся выделить память, выбрасывается std::bad_alloc.

Пример

#include <algorithm>
#include <iostream>
#include <vector>

int main()
{
    std::vector<int> v{3, 1, 4, 1, 5, 9};
    
    std::make_heap(v.begin(), v.end());
    
    // probably mess up the heap
    v.push_back(2);
    v.push_back(6);
    
    auto heap_end = std::is_heap_until(v.begin(), v.end());
    
    std::cout << "all of v:  ";
    for (const auto& i : v)
        std::cout << i << ' ';
    std::cout << '\n';
    
    std::cout << "only heap: ";
    for (auto i = v.begin(); i != heap_end; ++i)
        std::cout << *i << ' ';
    std::cout << '\n';
}

Вывод:

all of v:  9 5 4 1 1 3 2 6
only heap: 9 5 4 1 1 3 2

См. также

is_heap (C++11)	проверяет, является ли заданный диапазон максимальной кучей (шаблон функции и объект-функция алгоритма)
ranges::is_heap (C++20)
make_heap	создаёт максимальную кучу из диапазона элементов (шаблон функции и объект-функция алгоритма)
ranges::make_heap (C++20)
push_heap	добавляет элемент в максимальную кучу (шаблон функции и объект-функция алгоритма)
ranges::push_heap (C++20)
pop_heap	удаляет наибольший элемент из максимальной кучи (шаблон функции и объект-функция алгоритма)
ranges::pop_heap (C++20)
sort_heap	преобразует максимальную кучу в диапазон элементов, отсортированных по возрастанию (шаблон функции и объект-функция алгоритма)
ranges::sort_heap (C++20)
ranges::is_heap_until (C++20)	находит наибольший поддиапазон, являющийся максимальной кучей (объект-функция алгоритма)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/algorithm/is_heap_until