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

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (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>
呼叫簽名 (Call signature)
	(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 不同，它不提供對 Searcher（如 Boyer-Moore）的訪問。

特性測試宏	值	標準	特性
__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 (演算法函式物件)