std::includes
| 定义于头文件 <algorithm>
|
||
| (1) | ||
| template< class InputIt1, class InputIt2 > bool includes( InputIt1 first1, InputIt1 last1, |
(C++20 前) | |
| template< class InputIt1, class InputIt2 > constexpr bool includes( InputIt1 first1, InputIt1 last1, |
(C++20 起) | |
| template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 > bool includes( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1, |
(2) | (C++17 起) |
| (3) | ||
| template< class InputIt1, class InputIt2, class Compare > bool includes( InputIt1 first1, InputIt1 last1, |
(C++20 前) | |
| template< class InputIt1, class InputIt2, class Compare > constexpr bool includes( InputIt1 first1, InputIt1 last1, |
(C++20 起) | |
| template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class Compare > bool includes( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1, |
(4) | (C++17 起) |
若已排序范围 [first2, last2) 是已排序范围 [first1, last1) 的子序列则返回 true 。（子序列不必相接。）
comp 排序。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 的）类型 |
| 类型要求 | ||
-InputIt1, InputIt2 必须满足老式输入迭代器 (LegacyInputIterator) 的要求。
| ||
-ForwardIt1, ForwardIt2 必须满足老式向前迭代器 (LegacyForwardIterator) 的要求。
| ||
返回值
若 [first2, last2) 是 [first1, last1) 的子序列则为 true ；否则为 false 。
复杂度
至多比较 2·(N1+N2-1) 次，其中 N1 为 std::distance(first1, last1) 而 N2 为 std::distance(first2, last2) 。
异常
拥有名为 ExecutionPolicy 的模板形参的重载按下列方式报告错误：
- 若作为算法一部分调用的函数的执行抛出异常，且
ExecutionPolicy为标准策略之一，则调用 std::terminate 。对于任何其他ExecutionPolicy，行为是实现定义的。 - 若算法无法分配内存，则抛出 std::bad_alloc 。
可能的实现
| 版本一 |
|---|
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; } |
| 版本二 |
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 <iostream> #include <algorithm> #include <cctype> template<class Os, class Co> Os& operator<<(Os& os, const Co& v) { for (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++20) |
若一个序列是另一个的子列则返回 true (niebloid) |