std::ranges::equal

 

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> 定义
调用签名
template<std::input_iterator I1, std::sentinel_for<I1> S1,           std::input_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> constexprbool     equal( I1 first1, S1 last1, I2 first2, S2 last2, Pred pred ={},            Proj1 proj1 ={}, Proj2 proj2 ={});	(1)	(C++20 起)
template<ranges::input_range R1, ranges::input_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> constexprbool     equal( R1&& r1, R2&& r2, Pred pred ={}, Proj1 proj1 ={}, Proj2 proj2 ={});	(2)	(C++20 起)

1) 若范围 [first1, last1) 的投影值等于范围 [first2, last2) 的投影值则返回 true，否则返回 false。

2) 同 (1)，但以 r 为源范围，如同以 ranges::begin(r) 为 first 并以 ranges::end(r) 为 last。

若两个范围拥有相同数量的元素，且每对投影元素都满足 pred，即 std::invoke(pred, std::invoke(proj1, *first1), std::invoke(proj2, *first2)) 对范围中的所有对应元素对都返回 true，则认为它们相等。

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

• 调用它们中的任何一个时不能显式指定模板实参。
• 它们都不对实参依赖查找可见。
• 在通过函数调用运算符左侧的名字进行无限定查找，找到它们之一时，禁止实参依赖查找。

参数

first1, last1	-	要比较的第一元素范围的迭代器-哨位对
r1	-	要比较的第一元素范围
first2, last2	-	要比较的第二元素范围的迭代器-哨位对
r2	-	要比较的第二元素范围
pred	-	应用到投影后元素的二元谓词
proj1	-	应用到第一元素范围的投影
proj2	-	应用到第二元素范围的投影

返回值

若范围 [first1, last1) 的长度不等于范围 [first2, last2) 的长度，则返回 false。

若两个范围中的元素在投影后相等，则返回 true。

否则返回 false。

注解

不应使用 ranges::equal 对由 std::unordered_set、std::unordered_multiset、std::unordered_map 或 std::unordered_multimap 的迭代器组成的范围进行比较，因为即使两个容器存储相同元素，元素在容器中的存储顺序亦可以相异。

比较整个容器或字符串视图是否相等时，通常偏好对应类型的 operator==。

ranges::equal 不保证是短路的。例如，如果两个范围的首对元素不相等，剩余元素也可能被被比较。在用 std::memcmp 或实现特有的向量化算法比较范围时可能发生非短路比较。

复杂度

至多应用 min(last1 - first1, last2 - first2) 次谓词和对应的投影。

然而，若 S1 与 S2 均分别与其迭代器实现 std::sized_sentinel_for，且 last1 - first1 != last2 - first2，则不应用谓词（无需查看任何元素即可检测出大小不合）。

可能的实现

struct equal_fn {template<std::input_iterator I1, std::sentinel_for<I1> S1, std::input_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>constexprbool operator()(I1 first1, S1 last1, I2 first2, S2 last2, Pred pred ={}, Proj1 proj1 ={}, Proj2 proj2 ={})const{ifconstexpr(std::sized_sentinel_for<S1, I1> and std::sized_sentinel_for<S2, I2>)if(std::ranges::distance(first1, last1)!= std::ranges::distance(first2, last2))returnfalse;   for(; first1 != last1;++first1, (void)++first2)if(!std::invoke(pred, std::invoke(proj1, *first1), std::invoke(proj2, *first2)))returnfalse;returntrue;}   template<ranges::input_range R1, ranges::input_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>constexprbool 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::ref(pred), std::ref(proj1), std::ref(proj2));}};   inlineconstexpr equal_fn equal;

示例

下列代码用 equal() 测试字符串是否为回文

运行此代码

#include <algorithm>#include <iomanip>#include <iostream>#include <ranges>#include <string_view>   constexprbool is_palindrome(conststd::string_view s){namespace views = std::views;auto forward = s |views::take(s.size()/2);auto backward = s |views::reverse|views::take(s.size()/2);return std::ranges::equal(forward, backward);}   void test(conststd::string_view s){std::cout<<std::quoted(s)<<" is "<<(is_palindrome(s)?"":"not ")<<"a palindrome\n";}   int main(){ test("radar"); test("hello"); static_assert(is_palindrome("ABBA") and not is_palindrome("AC/DC"));}

输出：

"radar" is a palindrome "hello" is not a palindrome

参阅

ranges::findranges::find_ifranges::find_if_not (C++20)(C++20)(C++20)	查找首个满足特定条件的元素 (算法函数对象)
ranges::lexicographical_compare (C++20)	当一个范围字典序小于另一个时返回 true (算法函数对象)
ranges::mismatch (C++20)	查找两个范围的首个不同之处 (算法函数对象)
ranges::search (C++20)	搜索元素范围的首次出现 (算法函数对象)
ranges::equal_range (C++20)	返回匹配特定键值的元素范围 (算法函数对象)
equal_to	实现 x == y 的函数对象 (类模板)
equal	判断两组元素是否相同 (函数模板)