std::ranges::equal

来自cppreference.com
< cpp‎ | algorithm‎ | ranges
 
 
算法库
受约束算法及范围上的算法 (C++20)
包含算法例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
划分操作
排序操作
二分搜索操作(在已划分范围上)
集合操作(在有序范围上)
归并操作(在有序范围上)
堆操作
最小/最大操作
(C++11)
(C++17)
字典序比较操作
排列操作
C 库

数值运算
(C++11)                       
在未初始化内存上的操作
 
受约束算法
本菜单中的所有名字均属于命名空间 std::ranges
不修改序列的操作
修改序列的操作
划分操作
排序操作
二分搜索操作(在有序范围上)
       
       
集合操作(在有序范围上)
堆操作
最小/最大操作
       
       
排列操作
折叠操作
数值操作
(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>
constexpr bool
    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>
constexpr bool

    equal( R1&& r1, R2&& r2, Pred pred = {}, Proj1 proj1 = {}, Proj2 proj2 = {} );
(2) (C++20 起)
1) 若范围 [first1last1) 的投影值等于范围 [first2last2) 的投影值则返回 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 - 应用到第二元素范围的投影

返回值

若范围 [first1last1) 的长度不等于范围 [first2last2) 的长度,则返回 false

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

否则返回 false

注解

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

比较整个容器相等时,通常偏好对应容器的 operator==

复杂度

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

然而,若 S1S2 均分别与其迭代器实现 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>
  constexpr bool
      operator()(I1 first1, S1 last1, I2 first2, S2 last2,
                 Pred pred = {}, Proj1 proj1 = {}, Proj2 proj2 = {}) const
  {
      if constexpr (std::sized_sentinel_for<S1, I1> and std::sized_sentinel_for<S2, I2>)
          if (std::ranges::distance(first1, last1) != std::ranges::distance(first2, last2))
              return false;
 
      for (; first1 != last1; ++first1, (void)++first2)
          if (!std::invoke(pred, std::invoke(proj1, *first1), std::invoke(proj2, *first2)))
              return false;
      return true;
  }
 
  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>
  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::ref(pred), std::ref(proj1), std::ref(proj2));
  }
};
 
inline constexpr equal_fn equal;

示例

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

#include <algorithm>
#include <iomanip>
#include <iostream>
#include <ranges>
#include <string_view>
 
constexpr bool is_palindrome(const std::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(const std::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

参阅

查找满足特定条件的的第一个元素
(niebloid)
当一个范围按字典顺序小于另一个范围时,返回 true
(niebloid)
寻找两个范围出现不同的首个位置
(niebloid)
搜索一个元素范围的首次出现
(niebloid)
返回匹配特定键的元素范围
(niebloid)
实现 x == y 的函数对象
(类模板)
确定两个元素集合是否是相同的
(函数模板)