std::includes

Определён в заголовке `<algorithm>`
template< class InputIt1, class InputIt2 > bool includes( InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2 );	(1)	(constexpr начиная с C++20)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 > bool includes( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1, ForwardIt2 first2, ForwardIt2 last2 );	(2)	(начиная с C++17)
template< class InputIt1, class InputIt2, class Compare > bool includes( InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, Compare comp );	(3)	(constexpr начиная с C++20)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class Compare > bool includes( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1, ForwardIt2 first2, ForwardIt2 last2, Compare comp );	(4)	(начиная с C++17)

Возвращает true, если отсортированный диапазон [first2, last2) является подпоследовательностью отсортированного диапазона [first1, last1) (подпоследовательность не обязательно должна быть непрерывной).

1) Если [first1, last1) или [first2, last2) не отсортирован относительно operator<(до C++20)std::less{}(начиная с C++20), поведение не определено.

3) Если [first1, last1) или [first2, last2) не отсортирован относительно 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)

Параметры

first1, last1	-	пара итераторов, задающая отсортированный диапазон элементов для проверки
first2, last2	-	пара итераторов, задающая отсортированный диапазон элементов для поиска
policy	-	политика выполнения, которую следует использовать
comp	-	объект функции сравнения (то есть объект, удовлетворяющий требованиям Compare), который возвращает `true`, если первый аргумент меньше второго (то есть упорядочен перед ним). Сигнатура функции сравнения должна быть эквивалентна следующей: boolcmp(constType1&a,constType2&b); Хотя сигнатура не обязана содержать const&, функция не должна изменять переданные ей объекты и должна принимать любые значения типа (возможно, const) `Type1` и `Type2` независимо от категории значения (поэтому `Type1&` недопустимо, как и `Type1`, за исключением случая, когда для `Type1` перемещение эквивалентно копированию(начиная с C++11)). Типы Type1 и Type2 должны быть такими, чтобы объект типа InputIt можно было разыменовать и затем неявно преобразовать к каждому из них.
Требования к типам
-`InputIt1, InputIt2` должен удовлетворять требованиям LegacyInputIterator.
-`ForwardIt1, ForwardIt2` должен удовлетворять требованиям LegacyForwardIterator.
-`Compare` должен удовлетворять требованиям Compare.

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

true, если [first2, last2) является подпоследовательностью [first1, last1); в противном случае — false.

Пустая последовательность является подпоследовательностью любой последовательности, поэтому true возвращается, если [first2, last2) пуст.

Сложность

Пусть \(\scriptsize N_1\)N₁ — std::distance(first1, last1), а \(\scriptsize N_2\)N₂ — std::distance(first2, last2):

1,2) Не более \(\scriptsize 2 \cdot (N_1+N_2)-1\)2⋅(N₁+N₂)-1 сравнений с использованием operator<(до C++20)std::less{}(начиная с C++20).

3,4) Не более \(\scriptsize 2 \cdot (N_1+N_2)-1\)2⋅(N₁+N₂)-1 вызовов функции сравнения comp.

Исключения

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

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

Возможная реализация

include (1)
template<class InputIt1, class InputIt2> bool includes(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2) { for (; first2 != last2; ++first1) { if (first1 == last1 \|\| first2 < first1) return false; if (!(first1 < first2)) ++first2; } return true; }
include (3)
template<class InputIt1, class InputIt2, class Compare> bool includes(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, Compare comp) { for (; first2 != last2; ++first1) { if (first1 == last1 \|\| comp(first2, first1)) return false; if (!comp(first1, first2)) ++first2; } return true; }

include (1)

template<class InputIt1, class InputIt2>
bool includes(InputIt1 first1, InputIt1 last1,
              InputIt2 first2, InputIt2 last2)
{
    for (; first2 != last2; ++first1)
    {
        if (first1 == last1 || *first2 < *first1)
            return false;
        if (!(*first1 < *first2))
            ++first2;
    }
    return true;
}

include (3)

template<class InputIt1, class InputIt2, class Compare>
bool includes(InputIt1 first1, InputIt1 last1,
              InputIt2 first2, InputIt2 last2, Compare comp)
{
    for (; first2 != last2; ++first1)
    {
        if (first1 == last1 || comp(*first2, *first1))
            return false;
        if (!comp(*first1, *first2))
            ++first2;
    }
    return true;
}

Пример

#include <algorithm>
#include <cctype>
#include <iostream>

template<class Os, class Co>
Os& operator<<(Os& os, const Co& v)
{
    for (const auto& i : v)
        os << i << ' ';
    return os << '\t';
}

int main()
{
    const auto
        v1 = {'a', 'b', 'c', 'f', 'h', 'x'},
        v2 = {'a', 'b', 'c'},
        v3 = {'a', 'c'},
        v4 = {'a', 'a', 'b'},
        v5 = {'g'},
        v6 = {'a', 'c', 'g'},
        v7 = {'A', 'B', 'C'};

    auto no_case = [](char a, char b) { return std::tolower(a) < std::tolower(b); };

    std::cout
    << v1 << "\nincludes:\n" << std::boolalpha
    << v2 << ": " << std::includes(v1.begin(), v1.end(), v2.begin(), v2.end()) << '\n'
    << v3 << ": " << std::includes(v1.begin(), v1.end(), v3.begin(), v3.end()) << '\n'
    << v4 << ": " << std::includes(v1.begin(), v1.end(), v4.begin(), v4.end()) << '\n'
    << v5 << ": " << std::includes(v1.begin(), v1.end(), v5.begin(), v5.end()) << '\n'
    << v6 << ": " << std::includes(v1.begin(), v1.end(), v6.begin(), v6.end()) << '\n'
    << v7 << ": " << std::includes(v1.begin(), v1.end(), v7.begin(), v7.end(), no_case)
          << " (case-insensitive)\n";
}

Вывод:

a b c f h x
includes:
a b c   : true
a c     : true
a a b   : false
g       : false
a c g   : false
A B C   : true (case-insensitive)

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были применены ретроспективно к ранее опубликованным стандартам C++.

DR	Применён к	Поведение согласно опубликованному стандарту	Корректное поведение
LWG 1205	C++98	возвращаемое значение было не определено, если `[first2,` `last2)` пуст	в этом случае возвращает `true`

См. также

set_difference	вычисляет разность двух множеств (шаблон функции и функциональный объект-алгоритм)
ranges::set_difference (C++20)
search	ищет первое вхождение диапазона элементов (шаблон функции и функциональный объект-алгоритм)
ranges::search (C++20)
ranges::includes (C++20)	определяет, является ли одна последовательность подпоследовательностью другой (функциональный объект-алгоритм)

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