std::includes

在标头 `<algorithm>` 定义
template< class InputIt1, class InputIt2 > bool includes( InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2 );	(1)	(C++20 起为 `constexpr`)
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)	(C++20 起为 `constexpr`)
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 起)

在有序范围 [first2, last2) 是有序范围 [first1, last1) 的子序列的情况下返回 true（不必是连续的子序列）。

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>>	(C++20 前)
std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>>	(C++20 起)

是 true 时时才会参与重载决议。

参数

first1, last1	-	要检验的已排序元素范围
first2, last2	-	要搜索的已排序元素范围
policy	-	所用的执行策略。细节见执行策略。
comp	-	比较函数对象（即满足比较 (Compare) 概念的对象），在第一参数小于（即先序于）第二参数时返回 true。比较函数的签名应等价于如下： bool cmp(const Type1 &a, const Type2 &b); 虽然签名不必有 `const&`，函数也不能修改传递给它的对象，而且必须接受（可为 const 的）类型 `Type1` 与 `Type2` 的值，无关乎值类别（从而不允许 `Type1&` ，也不允许 `Type1`，除非 `Type1` 的移动等价于复制 (C++11 起)）。类型 Type1 与 Type2 必须使得 InputIt 类型的对象能在解引用后隐式转换到这两个类型。
类型要求
- `InputIt1, InputIt2` 必须满足老式输入迭代器 (LegacyInputIterator) 。
- `ForwardIt1, ForwardIt2` 必须满足老式向前迭代器 (LegacyForwardIterator) 。
- `Compare` 必须满足比较 (Compare) 。

返回值

在 [first2, last2) 是 [first1, last1) 的子序列时返回 true；否则返回 false。

因为空序列是所有序列的子序列，所以在 [first2, last2) 为空时会返回 true。

复杂度

给定 $\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 << "\n包含：\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)
          << "（大小写不敏感）\n";
}

输出：

a b c f h x
包含：
a b c   ：true
a c     ：true
a a b   ：false
g       ：false
a c g   ：false
A B C   ：true（大小写不敏感）

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告	应用于	出版时的行为	正确行为
LWG 1205	C++98	`[`first2`,` last2`)` 为空时返回值不明确	此时会返回 true

参阅

set_difference	计算两个集合的差集 (函数模板)
search	搜索一个元素范围的首次出现 (函数模板)
ranges::includes (C++20)	若一个序列是另一个的子列则返回 true (niebloid)

编译器支持
自立实现与有宿主实现
语言
标准库
标准库标头
具名要求
功能特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用工具库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
技术规范
符号索引
外部库

std::includes

参数

返回值

复杂度

异常

可能的实现

示例

缺陷报告

参阅

导航