std::ranges::contains, std::ranges::contains_subrange

 

C++

编译器支持

独立和宿主

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

算法库

约束算法和范围上的算法 (C++20)
约束算法，例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
is_execution_policy (C++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)    (C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
非修改序列操作 批量操作 for_each for_each_n (C++17) 搜索操作 all_ofany_ofnone_of (C++11)                (C++11)(C++11) countcount_if mismatch equal findfind_iffind_if_not (C++11) find_end find_first_of adjacent_find search search_n 修改序列操作 复制操作 copycopy_if (C++11) copy_backward copy_n (C++11) move (C++11) move_backward (C++11) 交换操作 swap iter_swap swap_ranges 转换操作 replacereplace_if transform replace_copyreplace_copy_if 生成操作 fill fill_n generate generate_n 移除操作 removeremove_if unique remove_copyremove_copy_if unique_copy 顺序更改操作 reverse reverse_copy rotate rotate_copy random_shuffleshuffle (C++17 前)(C++11) shift_leftshift_right (C++20)(C++20) 采样操作 sample (C++17)	排序和相关操作 划分操作 partition partition_copy (C++11)   stable_partition is_partitioned (C++11) partition_point (C++11) 排序操作 sort stable_sort partial_sort partial_sort_copy is_sorted (C++11) is_sorted_until (C++11) nth_element 二分搜索操作 (在已划分范围上) lower_bound upper_bound equal_range binary_search 集合操作 (在已排序范围上) includes set_union set_intersection set_difference set_symmetric_difference 合并操作 (在已排序范围上) merge inplace_merge 堆操作 push_heap pop_heap make_heap sort_heap is_heap (C++11) is_heap_until (C++11) 最小/最大操作 max min minmax (C++11) clamp (C++17) max_element min_element minmax_element (C++11) 字典序比较操作 lexicographical_compare lexicographical_compare_three_way (C++20) 排列操作 next_permutation prev_permutation is_permutation (C++11) C 库 qsort bsearch
数值操作
iota (C++11) inner_product adjacent_difference    accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17)    exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
未初始化内存上的操作
uninitialized_copy uninitialized_move (C++17)    uninitialized_fill uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)       uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)

 

约束算法

此菜单中的所有名称都属于命名空间 std::ranges

非修改序列操作

all_ofany_ofnone_of for_each for_each_n    countcount_if adjacent_find mismatch equal lexicographical_compare    containscontains_subrange (C++23)(C++23) findfind_iffind_if_not find_lastfind_last_iffind_last_if_not (C++23)(C++23)(C++23)   find_end find_first_of search search_n starts_with (C++23) ends_with (C++23)

修改序列操作

copycopy_if copy_n copy_backward    move move_backward shift_leftshift_right (C++23)(C++23)   fill fill_n generate generate_n    transform swap_ranges    shuffle sample removeremove_if replacereplace_if reverse rotate remove_copyremove_copy_if    unique replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy

划分操作

is_partitioned    partition_point    partition    partition_copy    stable_partition

排序操作

is_sorted is_sorted_until     sort stable_sort         partial_sort       nth_element partial_sort_copy

二分搜索操作（在已排序范围上）

lower_bound         upper_bound         binary_search      equal_range

集合操作 (在已排序范围上)

merge inplace_merge       set_difference set_intersection    set_union          includes set_symmetric_difference

堆操作

is_heap is_heap_until       make_heap           sort_heap push_heap pop_heap

最小/最大操作

max max_element         min min_element         minmax minmax_element     clamp

排列操作

is_permutation      next_permutation    prev_permutation

折叠操作

fold_left (C++23) fold_left_first (C++23)   fold_right (C++23) fold_right_last (C++23)   fold_left_with_iter (C++23) fold_left_first_with_iter (C++23)

数值操作 iota (C++23)             随机数生成 generate_random (C++26)

未初始化存储上的操作

construct_at    destroy destroy_n destroy_at uninitialized_copy    uninitialized_move uninitialized_fill uninitialized_copy_n    uninitialized_move_n uninitialized_fill_n uninitialized_default_construct uninitialized_default_construct_n uninitialized_value_construct uninitialized_value_construct_n

返回类型

in_fun_result in_in_result in_found_result    in_out_result in_in_out_result    in_out_out_result    min_max_result out_value_result (C++23) in_value_result (C++23)

 

定义于头文件 <algorithm>
调用签名
	(1)
template< std::input_iterator I, std::sentinel_for<I> S,           class T,           class Proj = std::identity > requires std::indirect_binary_predicate<ranges::equal_to, std::projected<I, Proj>,                                         const T*> constexpr bool contains( I first, S last, const T& value, Proj proj = {} );			(自 C++23 起) (C++26 前)
template< std::input_iterator I, std::sentinel_for<I> S,           class Proj = std::identity,           class T = std::projected_value_t<I, Proj> > requires std::indirect_binary_predicate<ranges::equal_to, std::projected<I, Proj>,                                         const T*> constexpr bool contains( I first, S last, const T& value, Proj proj = {} );			(自 C++26 起)
		(2)
template< ranges::input_range R,           class T,           class Proj = std::identity > requires std::indirect_binary_predicate<ranges::equal_to,                                         std::projected<ranges::iterator_t<R>, Proj>,                                         const T*> constexpr bool contains( R&& r, const T& value, Proj proj = {} );				(自 C++23 起) (C++26 前)
template< ranges::input_range R,           class Proj = std::identity,           class T = std::projected_value_t<ranges::iterator_t<R>, Proj> > requires std::indirect_binary_predicate<ranges::equal_to,                                         std::projected<ranges::iterator_t<R>, Proj>,                                         const T*> constexpr bool contains( R&& r, const T& value, Proj proj = {} );				(自 C++26 起)
template< std::forward_iterator I1, std::sentinel_for<I1> S1,           std::forward_iterator I2, std::sentinel_for<I2> S2,           class Pred = ranges::equal_to,           class Proj1 = std::identity, class Proj2 = std::identity > requires std::indirectly_comparable<I1, I2, Pred, Proj1, Proj2> constexpr bool contains_subrange( I1 first1, S1 last1, I2 first2, S2 last2,                                   Pred pred = {},                                   Proj1 proj1 = {}, Proj2 proj2 = {} );			(3)	(自 C++23 起)
template< ranges::forward_range R1, ranges::forward_range R2,           class Pred = ranges::equal_to,           class Proj1 = std::identity, class Proj2 = std::identity > requires std::indirectly_comparable<ranges::iterator_t<R1>,                                     ranges::iterator_t<R2>, Pred, Proj1, Proj2> constexpr bool contains_subrange( R1&& r1, R2&& r2, Pred pred = {},                                   Proj1 proj1 = {}, Proj2 proj2 = {} );			(4)	(自 C++23 起)

1) 基于搜索的算法，检查给定范围是否包含带有迭代器-哨兵对的值。

2) 与 (1) 相同，但使用 r 作为源范围，如同使用 ranges::begin(r) 作为 first 和 ranges::end(r) 作为 last。

3) 基于搜索的算法，检查给定范围是否是另一个范围的子范围，使用迭代器-哨兵对。

4) 与 (3) 相同，但使用 r1 作为第一个源范围，r2 作为第二个源范围，如同使用 ranges::begin(r1) 作为 first1, ranges::end(r1) 作为 last1, ranges::begin(r2) 作为 first2, 和 ranges::end(r2) 作为 last2。

此页面上描述的类似函数的实体是算法函数对象（非正式地称为 niebloids），即

• 调用它们时，无法指定显式模板参数列表。
• 它们都对实参依赖查找不可见。
• 当通过正常非限定查找找到它们中的任何一个作为函数调用运算符左侧的名称时，实参依赖查找会被抑制。

参数

first, last	-	定义要检查的元素的范围的迭代器-哨兵对
r	-	要检查的元素的范围
value	-	用于与元素比较的值
pred	-	应用于投影元素的谓词
proj	-	应用于元素的投影

返回值

1,2) : ranges::find(std::move(first), last, value, proj) != last

3,4) : first2 == last2 || !ranges::search(first1, last1, first2, last2, pred, proj1, proj2).empty()

复杂度

最多 last - first 次谓词和投影的应用。

注解

直到 C++20，我们都必须写 std::ranges::find(r, value) != std::ranges::end(r) 来确定单个值是否在范围内部。并且为了检查范围是否包含感兴趣的子范围，我们使用 not std::ranges::search(haystack, needle).empty()。虽然这是准确的，但并不一定方便，并且几乎没有表达意图（尤其是在后一种情况下）。能够说 std::ranges::contains(r, value) 解决了这两个问题。

ranges::contains_subrange，与 ranges::search 相同，但与 std::search 相比，不提供对 Searchers（例如 Boyer-Moore）的访问。

特性测试 宏	值	Std	特性
__cpp_lib_ranges_contains	202207L	(C++23)	std::ranges::contains 和 ranges::contains_subrange
__cpp_lib_algorithm_default_value_type	202403	(C++26)	列表初始化 用于算法 (1,2)

可能的实现

contains (1,2)
struct __contains_fn { template<std::input_iterator I, std::sentinel_for<I> S, class Proj = std::identity, class T = std::projected_value_t<I, Proj>> requires std::indirect_binary_predicate<ranges::equal_to, std::projected<I, Proj>, const T*> constexpr bool operator()(I first, S last, const T& value, Proj proj = {}) const { return ranges::find(std::move(first), last, value, proj) != last; }   template<ranges::input_range R, class Proj = std::identity, class T = std::projected_value_t<ranges::iterator_t<R>, Proj>> requires std::indirect_binary_predicate<ranges::equal_to, std::projected<ranges::iterator_t<R>, Proj>, const T*> constexpr bool operator()(R&& r, const T& value, Proj proj = {}) const { return (*this)(ranges::begin(r), ranges::end(r), std::move(value), proj); } };   inline constexpr __contains_fn contains {};
contains_subrange (3,4)
struct __contains_subrange_fn { template<std::forward_iterator I1, std::sentinel_for<I1> S1, std::forward_iterator I2, std::sentinel_for<I2> S2, class Pred = ranges::equal_to, class Proj1 = std::identity, class Proj2 = std::identity> requires std::indirectly_comparable<I1, I2, Pred, Proj1, Proj2> constexpr bool operator()(I1 first1, S1 last1, I2 first2, S2 last2, Pred pred = {}, Proj1 proj1 = {}, Proj2 proj2 = {}) const { return (first2 == last2) || !ranges::search(first1, last1, first2, last2, pred, proj1, proj2).empty(); }   template<ranges::forward_range R1, ranges::forward_range R2, class Pred = ranges::equal_to, class Proj1 = std::identity, class Proj2 = std::identity> requires std::indirectly_comparable<ranges::iterator_t<R1>, ranges::iterator_t<R2>, Pred, Proj1, Proj2> constexpr bool operator()(R1&& r1, R2&& r2, Pred pred = {}, Proj1 proj1 = {}, Proj2 proj2 = {}) const { return (*this)(ranges::begin(r1), ranges::end(r1), ranges::begin(r2), ranges::end(r2), std::move(pred), std::move(proj1), std::move(proj2)); } };   inline constexpr __contains_subrange_fn contains_subrange {};

示例

运行此代码

#include <algorithm>
#include <array>
#include <complex>
 
namespace ranges = std::ranges;
 
int main()
{
    constexpr auto haystack = std::array{3, 1, 4, 1, 5};
    constexpr auto needle = std::array{1, 4, 1};
    constexpr auto bodkin = std::array{2, 5, 2};
 
    static_assert(
        ranges::contains(haystack, 4) &&
       !ranges::contains(haystack, 6) &&
        ranges::contains_subrange(haystack, needle) &&
       !ranges::contains_subrange(haystack, bodkin)
    );
 
    constexpr std::array<std::complex<double>, 3> nums{{{1, 2}, {3, 4}, {5, 6}}};
    #ifdef __cpp_lib_algorithm_default_value_type
        static_assert(ranges::contains(nums, {3, 4}));
    #else
        static_assert(ranges::contains(nums, std::complex<double>{3, 4}));
    #endif
}

参见

ranges::findranges::find_ifranges::find_if_not (C++20)(C++20)(C++20)	查找满足特定条件的第一个元素 (算法函数对象)
ranges::search (C++20)	搜索元素范围的首次出现 (算法函数对象)
ranges::binary_search (C++20)	确定元素是否存在于部分排序的范围中 (算法函数对象)
ranges::includes (C++20)	如果一个序列是另一个序列的子序列，则返回 true (算法函数对象)
ranges::all_ofranges::any_ofranges::none_of (C++20)(C++20)(C++20)	检查谓词对于范围中所有、任何或没有元素是否为 true (算法函数对象)