std::includes

定义于头文件 `<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)

如果已排序范围 [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>> 为 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`，移动等效于复制(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 << "\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	计算两个集合之间的差集 (函数模板) [编辑]
search	搜索某个元素范围的首次出现 (函数模板) [编辑]
ranges::includes (C++20)	如果一个序列是另一个序列的子序列，则返回 true (算法函数对象)[编辑]

编译器支持
独立式和宿主式
语言
标准库
标准库头文件
具名要求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
诊断库
内存管理库
元编程库 (C++11)
通用工具库
容器库
迭代器库
范围库 (C++20)
算法库
字符串库
文本处理库
数值库
日期和时间库
输入/输出库
文件系统库 (C++17)
并发支持库 (C++11)
执行控制库 (C++26)
技术规范
符号索引
外部库

cppreference.cn

命名空间

变体

视图

操作