命名空间
变体
操作

std::ranges::equal

来自 cppreference.cn
< cpp‎ | algorithm‎ | ranges
 
 
算法库
约束算法和范围算法 (C++20)
约束算法,例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
划分操作
排序操作
二分搜索操作
(在已划分范围上)
集合操作 (在已排序范围上)
合并操作 (在已排序范围上)
堆操作
最小值/最大值操作
(C++11)
(C++17)
字典序比较操作
排列操作
C 库
数值操作
未初始化内存上的操作
 
约束算法
此菜单中的所有名称都属于命名空间 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) (since 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) (since C++20)
1) 如果范围 [first1last1) 的投影值等于范围 [first2last2) 的投影值,则返回 true,否则返回 false
2)(1) 相同,但使用 r 作为源范围,如同使用 ranges::begin(r) 作为 firstranges::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 - 应用于第二个元素范围的投影

[编辑] 返回值

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

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

否则返回 false

[编辑] 注意

ranges::equal 不应用于比较由来自 std::unordered_setstd::unordered_multisetstd::unordered_mapstd::unordered_multimap 的迭代器形成的范围,因为即使两个容器存储相同的元素,元素在这些容器中的存储顺序也可能不同。

当比较整个容器或字符串视图是否相等时,通常首选相应类型的 operator==

ranges::equal 不保证是短路求值的。例如,如果两个范围的第一对元素比较不相等,也可能比较其余的元素。当使用 std::memcmp 或特定于实现的向量化算法比较范围时,可能会发生非短路比较。

[编辑] 复杂度

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

[编辑] 示例

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

[编辑] 参见

查找满足特定条件的第一个元素
(算法函数对象)[编辑]
如果一个范围在字典序上小于另一个范围,则返回 true
(算法函数对象)[编辑]
查找两个范围首次不同的位置
(算法函数对象)[编辑]
搜索一个元素范围的首次出现
(算法函数对象)[编辑]
返回与特定键匹配的元素范围
(算法函数对象)[编辑]
实现 x == y 的函数对象
(类模板) [编辑]
确定两个元素集合是否相同
(函数模板) [编辑]