std::ranges::equal

定义于头文件 `<algorithm>`
调用签名 (Call signature)
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) 如果范围 [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。

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

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

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>
  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;

[编辑] 示例

以下代码使用 ranges::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

[编辑] 参阅

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	判断两组元素是否相同 (函数模板) [编辑]

编译器支持
自由（freestanding）与宿主（hosted）
语言
标准库
标准库头文件
具名要求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
诊断库
内存管理库
元编程库 (C++11)
通用工具库
容器库
迭代器库
范围库 (C++20)
算法库
字符串库
文本处理库
数值库
日期和时间库
输入/输出库
文件系统库 (C++17)
并发支持库 (C++11)
执行控制库 (C++26)
技术规范
符号索引
外部库

cppreference.cn

命名空间

变体

视图

操作