命名空间
变体
操作

std::includes

来自 cppreference.com
< cpp‎ | algorithm
 
 
算法库
约束算法和范围上的算法 (C++20)
约束算法,例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
分区操作
排序操作
二分搜索操作
(在分区范围内)
集合操作(在排序范围内)
合并操作(在排序范围内)
堆操作
最小/最大操作
(C++11)
(C++17)
字典序比较操作
排列操作
C 库
数值操作
未初始化内存操作
 
在头文件 <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 开始)

如果排序后的范围 [first2last2) 是排序后的范围 [first1last1)子序列(子序列不必是连续的),则返回 true

1) 如果 [first1last1)[first2last2) 相对于 operator<(直到 C++20)std::less{}(从 C++20 开始) 未排序,则行为未定义。
3) 如果 [first1last1)[first2last2) 相对于 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)Type1Type2 的所有值,无论其值类别如何(因此,不允许 Type1&,也不允许 Type1,除非对于 Type1 移动等效于复制(自 C++11 起))。
类型 Type1Type2 必须使类型 InputIt 的对象可以解引用,然后隐式转换为两者。​

类型要求
-
InputIt1, InputIt2 必须满足 LegacyInputIterator 的要求。
-
ForwardIt1, ForwardIt2 必须满足 LegacyForwardIterator 的要求。
-
Compare 必须满足 Compare 的要求。

[编辑] 返回值

如果 [first2last2)[first1last1) 的子序列,则返回 true;否则返回 false

空序列是任何序列的子序列,因此如果 [first2last2) 为空,则返回 true

[编辑] 复杂度

给定 N
1
std::distance(first1, last1)N
2
std::distance(first2, last2)

1,2) 使用 operator<(直到 C++20)std::less{}(自 C++20 起) 最多进行 2⋅(N
1
+N
2
)-1
次比较。
3,4) 最多对比较函数 comp 应用 2⋅(N
1
+N
2
)-1
次。

[编辑] 异常

具有名为 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 如果 [first2last2) 为空,则返回值不明确。 在这种情况下返回 true

[编辑] 另请参阅

计算两个集合之间的差集
(函数模板) [编辑]
搜索元素范围的第一次出现
(函数模板) [编辑]
如果一个序列是另一个序列的子序列,则返回 true
(niebloid)[编辑]