# std::ranges::equal

< cpp‎ | algorithm‎ | ranges

定义于头文件 `<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) 若范围 `[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==` 。

### 复杂度

至多应用 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 (ranges::distance(first1, last1) != 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, std::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 <iostream>
    #include <string_view>
    #include <ranges>

    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 << "\"" << s << "\" is"
            << (is_palindrome(s) ? "" : "not")
            << " a palindrome\n";
    }

    int main()
    {
        test("radar");
        test("hello");
    }

输出：

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

### 参阅

ranges::find ranges::find_if ranges::find_if_not (C++20)(C++20)(C++20) | 寻找首个满足特定判别标准的元素 (niebloid)
ranges::lexicographical_compare (C++20) | 当一个范围按字典顺序小于另一个范围时，返回 true (niebloid)
ranges::mismatch (C++20) | 寻找两个范围出现不同的首个位置 (niebloid)
ranges::search (C++20) | 搜索一个元素范围 (niebloid)
equal | 确定两个元素集合是否是相同的 (函数模板)