std::equal
| 定义于头文件 <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)。
operator== 比较。p 比较。policy 执行。true 时参与重载决议:
|
|
(直到 C++20) |
|
|
(自 C++20 起) |
参数
| first1, last1 | - | 定义要比较的第一个范围的迭代器对 |
| first2, last2 | - | 定义要比较的第二个范围的迭代器对 |
| policy | - | 要使用的执行策略 |
| p | - | 二元谓词,如果应将元素视为相等则返回 true。 谓词函数的签名应等价于以下内容:
虽然签名不需要有 |
| 类型要求 | ||
-InputIt1, InputIt2 必须满足 LegacyInputIterator 的要求。
| ||
-ForwardIt1, ForwardIt2 必须满足 LegacyForwardIterator 的要求。
| ||
-BinaryPred 必须满足 BinaryPredicate 的要求。
| ||
返回值
true。否则返回 false。std::distance(first1, last1) 和 std::distance(first2, last2) 相等,并且两个范围中的每个对应元素都相等,则返回 true。否则返回 false。复杂度
给定 N1 为 std::distance(first1, last1),N2 为 std::distance(first2, last2):
operator== 的比较。operator== 的比较。p 的应用。p 的应用。InputIt1 和 InputIt2 都是 LegacyRandomAccessIterator,并且 last1 - first1 != last2 - first2 为 true,则不进行比较。operator== 的比较。operator== 的比较。p 的应用。p 的应用。异常
带有模板参数名为 ExecutionPolicy 的重载按如下方式报告错误:
- 如果执行作为算法一部分调用的函数抛出异常,并且
ExecutionPolicy是标准策略之一,则调用 std::terminate。对于任何其他ExecutionPolicy,行为由实现定义。 - 如果算法分配内存失败,则抛出 std::bad_alloc。
可能的实现
| 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());
}
|
注解
std::equal 不应用于比较由来自 std::unordered_set、std::unordered_multiset、std::unordered_map 或 std::unordered_multimap 的迭代器构成的范围,因为这些容器中元素的存储顺序可能不同,即使两个容器存储相同的元素。
当比较整个容器或 string view(自 C++17 起)是否相等时,通常首选相应类型的 operator==。
顺序的 std::equal 不保证短路。例如,如果两个范围的第一个元素对不相等,后续元素也可能被比较。当使用 std::memcmp 或实现特定的向量化算法比较范围时,可能会发生非短路比较。
示例
以下代码使用 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
参阅
(C++11) |
查找满足特定条件的第一个元素 (函数模板 & 算法函数对象) |
(C++20)(C++20)(C++20) |
|
| 按字典序比较两个范围 (函数模板 & 算法函数对象) | |
| 查找两个范围第一个不同的位置 (函数模板 & 算法函数对象) | |
(C++20) |
|
| 搜索一个元素范围的首次出现 (函数模板 & 算法函数对象) | |
(C++20) |
|
(C++20) |
确定两组元素是否相同 (算法函数对象) |
实现 x == y 的函数对象(类模板) | |
| 使用二分搜索查找匹配给定值的元素范围 (函数模板 & 算法函数对象) | |
(C++20) |