命名空间
变体
操作

std::equal

来自 cppreference.com
< cpp‎ | algorithm
 
C++
 
算法库
受约束的算法和范围上的算法 (C++20)
受约束的算法，例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
分区操作
排序操作
二分搜索操作
(在分区范围上)
集合操作（在排序范围上）
合并操作（在排序范围上）
堆操作
最小/最大操作
(C++11)
(C++17)
字典序比较操作
(C++20)
排列操作
C 库
数值操作
未初始化内存上的操作
 
定义在头文件 <algorithm> 中
template< class InputIt1, class InputIt2 >

bool equal( InputIt1 first1, InputIt1 last1,

            InputIt2 first2 );
 (1) (从 C++20 开始支持 constexpr)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 >

bool equal( ExecutionPolicy&& policy,
            ForwardIt1 first1, ForwardIt1 last1,

            ForwardIt2 first2 );
 (2) (从 C++17 开始支持)
template< class InputIt1, class InputIt2, class BinaryPred >

bool equal( InputIt1 first1, InputIt1 last1,

            InputIt2 first2, BinaryPred p );
 (3) (从 C++20 开始支持 constexpr)
template< class ExecutionPolicy,

          class ForwardIt1, class ForwardIt2, class BinaryPred >
bool equal( ExecutionPolicy&& policy,
            ForwardIt1 first1, ForwardIt1 last1,

            ForwardIt2 first2, BinaryPred p );
 (4) (从 C++17 开始支持)
template< class InputIt1, class InputIt2 >

bool equal( InputIt1 first1, InputIt1 last1,

            InputIt2 first2, InputIt2 last2 );
 (5) (从 C++14 开始支持)
(从 C++20 开始支持 constexpr)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 >

bool equal( ExecutionPolicy&& policy,
            ForwardIt1 first1, ForwardIt1 last1,

            ForwardIt2 first2, ForwardIt2 last2 );
 (6) (从 C++17 开始支持)
template< class InputIt1, class InputIt2, class BinaryPred >

bool equal( InputIt1 first1, InputIt1 last1,

            InputIt2 first2, InputIt2 last2, BinaryPred p );
 (7) (从 C++14 开始支持)
(从 C++20 开始支持 constexpr)
template< class ExecutionPolicy,

          class ForwardIt1, class ForwardIt2, class BinaryPred >
bool equal( ExecutionPolicy&& policy,
            ForwardIt1 first1, ForwardIt1 last1,

            ForwardIt2 first2, ForwardIt2 last2, BinaryPred p );
 (8) (从 C++17 开始支持)

检查 [first1, last1) 和从 first2 开始的范围是否相等

  • 对于重载 (1-4)，第二个范围具有 std::distance(first1, last1) 个元素。
  • 对于重载 (5-8)，第二个范围是 [first2, last2)。
1,5) 元素使用 operator== 进行比较。
3,7) 元素使用给定的二元谓词 p 进行比较。
2,4,6,8) 与 (1,3,5,7) 相同，但根据 policy 执行。
这些重载仅在以下情况下参与重载解析：

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> 为 true。

 (直到 C++20)

std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> 为 true。

 (从 C++20 开始支持)

内容

[编辑] 参数

first1, last1 - 要比较的元素的第一个范围
first2, last2 - 要比较的元素的第二个范围
policy - 要使用的执行策略。有关详细信息，请参见 执行策略。
p - 返回​true的二元谓词，如果元素应该被视为相等。

谓词函数的签名应该等效于以下内容

 bool pred(const Type1 &a, const Type2 &b);

虽然签名不需要有const &，但该函数不得修改传递给它的对象，并且必须能够接受类型（可能是 const）Type1 和 Type2 的所有值，无论值类别是什么（因此，Type1 &不允许，除非对于 Type1，移动等效于复制(自 C++11 起)）。
类型 Type1 和 Type2 必须是类型 InputIt1 和 InputIt2 的对象可以被解引用，然后隐式转换为 Type1 和 Type2 的类型。

类型要求
-
InputIt1, InputIt2 必须满足LegacyInputIterator 的要求。
-
ForwardIt1, ForwardIt2 必须满足LegacyForwardIterator 的要求。
-
BinaryPred 必须满足BinaryPredicate 的要求。

[edit] 返回值

1-4) 如果两个范围中的每个对应元素相等，则返回 true。否则返回 false。
5-8) 如果 std::distance(first1, last1) 和 std::distance(first2, last2) 相等，并且两个范围中的每个对应元素相等，则返回 true。否则返回 false。

[edit] 复杂度

假设 N
1 为 std::distance(first1, last1)，N
2 为 std::distance(first2, last2)

1) 最多 N
1 次使用 operator== 的比较。
2) O(N
1) 次使用 operator== 的比较。
3) 最多 N
1 次应用谓词 p。
4) O(N
1) 次应用谓词 p。
5-8) 如果 InputIt1 和 InputIt2 都是 LegacyRandomAccessIterator，并且 last1 - first1 != last2 - first2 为 true，则不会进行任何比较。
否则，假设 N 为 min(N
1,N
2)
5) 最多 N 次使用 operator== 的比较。
6) O(N) 次使用 operator== 的比较。
7) 最多 N 次应用谓词 p。
8) O(N) 次应用谓词 p。

[edit] 异常

具有名为 ExecutionPolicy 的模板参数的重载报告错误如下

  • 如果作为算法的一部分调用的函数的执行抛出异常，并且 ExecutionPolicy 是标准策略之一，则调用 std::terminate。对于任何其他 ExecutionPolicy，行为是实现定义的。
  • 如果算法无法分配内存，则抛出 std::bad_alloc。

[edit] 可能的实现

equal (1) 
template<class InputIt1, class InputIt2>
constexpr //< since C++20
bool equal(InputIt1 first1, InputIt1 last1, InputIt2 first2)
{
    for (; first1 != last1; ++first1, ++first2)
        if (!(*first1 == *first2))
            return false;
 
    return true;
}
equal (3) 
template<class InputIt1, class InputIt2, class BinaryPred>
constexpr //< since C++20
bool equal(InputIt1 first1, InputIt1 last1,
           InputIt2 first2, BinaryPred p)
{
    for (; first1 != last1; ++first1, ++first2)
        if (!p(*first1, *first2))
            return false;
 
    return true;
}
equal (5) 
namespace detail
{
    // random-access iterator implementation (allows quick range size detection)
    template<class RandomIt1, class RandomIt2>
    constexpr //< since C++20
    bool equal(RandomIt1 first1, RandomIt1 last1, RandomIt2 first2, RandomIt2 last2,
               std::random_access_iterator_tag, std::random_access_iterator_tag)
    {
        if (last1 - first1 != last2 - first2)
            return false;
 
        for (; first1 != last1; ++first1, ++first2)
            if (!(*first1 == *first2))
                return false;
 
        return true;
    }
 
    // input iterator implementation (needs to manually compare with “last2”)
    template<class InputIt1, class InputIt2>
    constexpr //< since C++20
    bool equal(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2,
               std::input_iterator_tag, std::input_iterator_tag)
    {
        for (; first1 != last1 && first2 != last2; ++first1, ++first2)
            if (!(*first1 == *first2))
                return false;
 
        return first1 == last1 && first2 == last2;
    }
}
 
template<class InputIt1, class InputIt2>
constexpr //< since C++20
bool equal(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2)
{
    details::equal(first1, last1, first2, last2,
                   typename std::iterator_traits<InputIt1>::iterator_category(),
                   typename std::iterator_traits<InputIt2>::iterator_category());
}
equal (7) 
namespace detail
{
    // random-access iterator implementation (allows quick range size detection)
    template<class RandomIt1, class RandomIt2, class BinaryPred>
    constexpr //< since C++20
    bool equal(RandomIt1 first1, RandomIt1 last1,
               RandomIt2 first2, RandomIt2 last2, BinaryPred p,
               std::random_access_iterator_tag, std::random_access_iterator_tag)
    {
        if (last1 - first1 != last2 - first2)
            return false;
 
        for (; first1 != last1; ++first1, ++first2)
            if (!p(*first1, *first2))
                return false;
 
        return true;
    }
 
    // input iterator implementation (needs to manually compare with “last2”)
    template<class InputIt1, class InputIt2, class BinaryPred>
    constexpr //< since C++20
    bool equal(InputIt1 first1, InputIt1 last1,
               InputIt2 first2, InputIt2 last2, BinaryPred p,
               std::input_iterator_tag, std::input_iterator_tag)
    {
        for (; first1 != last1 && first2 != last2; ++first1, ++first2)
            if (!p(*first1, *first2))
                return false;
 
        return first1 == last1 && first2 == last2;
    }
}
 
template<class InputIt1, class InputIt2, class BinaryPred>
constexpr //< since C++20
bool equal(InputIt1 first1, InputIt1 last1,
           InputIt2 first2, InputIt2 last2, BinaryPred p)
{
    details::equal(first1, last1, first2, last2, p,
                   typename std::iterator_traits<InputIt1>::iterator_category(),
                   typename std::iterator_traits<InputIt2>::iterator_category());
}

[edit] 注意

std::equal 不应该用于比较由 std::unordered_set、std::unordered_multiset、std::unordered_map 或 std::unordered_multimap 的迭代器形成的范围，因为即使两个容器存储相同的元素，它们存储元素的顺序也可能不同。

当比较整个容器的相等性时，通常更喜欢对应容器的 operator==。

[edit] 示例

以下代码使用 std::equal 来测试一个字符串是否是回文。

运行此代码
#include <algorithm>
#include <iomanip>
#include <iostream>
#include <string_view>
 
constexpr bool is_palindrome(const std::string_view& s)
{
    return std::equal(s.cbegin(), s.cbegin() + s.size() / 2, s.crbegin());
}
 
void test(const std::string_view& s)
{
    std::cout << std::quoted(s)
              << (is_palindrome(s) ? " is" : " is not")
              << " a palindrome\n";
}
 
int main()
{
    test("radar");
    test("hello");
}

输出

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

[edit] 参见

(C++11)
 查找满足特定条件的第一个元素
(函数模板) [edit]
 如果一个范围在词法上小于另一个范围，则返回 true
(函数模板) [edit]
 查找两个范围不同的第一个位置
(函数模板) [edit]
 搜索一系列元素的第一个出现位置
(函数模板) [edit]
(C++20)
 确定两组元素是否相同
(niebloid)[edit]
 实现 x == y 的函数对象
(类模板) [edit]
 返回与特定键匹配的元素范围
(函数模板) [edit]
Retrieved from "https://cppreference.cn/mwiki/index.php?title=cpp/algorithm/equal&oldid=170764"