std:: includes

From cppreference.net

Определено в заголовке `<algorithm>`
template < class InputIt1, class InputIt2 > bool includes ( InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2 ) ;	(1)	(constexpr since C++20)
template < class ExecutionPolicy, class ForwardIt1, class ForwardIt2 > bool includes ( ExecutionPolicy && policy, ForwardIt1 first1, ForwardIt1 last1, ForwardIt2 first2, ForwardIt2 last2 ) ;	(2)	(since C++17)
template < class InputIt1, class InputIt2, class Compare > bool includes ( InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, Compare comp ) ;	(3)	(constexpr since 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)	(since 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 .

Эти перегрузки участвуют в разрешении перегрузки только при выполнении всех следующих условий:

std:: is_execution_policy_v < std:: decay_t < ExecutionPolicy >> является true .	(до C++20)
std:: is_execution_policy_v < std:: remove_cvref_t < ExecutionPolicy >> является true .	(начиная с C++20)

Содержание

Параметры

first1, last1	-	пара итераторов, определяющих отсортированный диапазон элементов для проверки
first2, last2	-	пара итераторов, определяющих отсортированный диапазон элементов для поиска
policy	-	политика выполнения, которая будет использоваться
comp	-	функция сравнения (т.е. объект, удовлетворяющий требованиям Compare ), которая возвращает true если первый аргумент меньше второго (т.е. упорядочен перед вторым). Сигнатура функции сравнения должна быть эквивалентна следующей: bool cmp ( const Type1 & a, const Type2 & b ) ; Хотя сигнатура не обязана содержать const & , функция не должна модифицировать передаваемые ей объекты и должна быть способна принимать все значения типа (возможно const) `Type1` и `Type2` независимо от категории значения (следовательно, `Type1&` не допускается , как и `Type1` , если для `Type1` перемещение не эквивалентно копированию (since 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 1$ равно std:: distance ( first1, last1 ) и $\scriptsize N_2$ $N 2$ равно std:: distance ( first2, last2 ) :

1,2) Не более

2\cdot(N 1 +N 2)-1

сравнений с использованием operator < (до C++20) std:: less { } (начиная с C++20) .

3,4) Не более

2\cdot(N 1 +N 2)-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 <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	Applied to	Behavior as published	Correct behavior
LWG 1205	C++98	the return value was unclear if `[` first2 `,` last2 `)` is empty	returns true in this case

Смотрите также

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

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Diagnostics library
Memory management library
Metaprogramming library (C++11)
General utilities library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Strings library
Text processing library
Numerics library
Date and time library
Input/output library
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Technical specifications
Symbols index
External libraries

cppreference.net

Namespaces

Variants