Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/algorithm/equal"

From cppreference.com
< cpp‎ | algorithm
m
m (use {{v}})
Line 29: Line 29:
 
@3,4@ Returns {{c|true}} if the range {{tt|[first1, last1)}} is equal to the range {{tt|[first2, last2)}}, and {{c|false}} otherwise.
 
@3,4@ Returns {{c|true}} if the range {{tt|[first1, last1)}} is equal to the range {{tt|[first2, last2)}}, and {{c|false}} otherwise.
  
−
The two ranges are considered equal if, for every iterator {{tt|i}} in the range {{tt|[first1,last1)}}, {{c|*i}} equals {{c|*(first2 + (i - first1))}}. The overloads (1) and (3) use {{c|operator{{==}}}} to determine if two elements are equal, whereas overloads (2) and (4) use the given binary predicate {{tt|p}}.
+
The two ranges are considered equal if, for every iterator {{tt|i}} in the range {{tt|[first1,last1)}}, {{c|*i}} equals {{c|*(first2 + (i - first1))}}. The overloads {{v|1,3}} use {{c|operator{{==}}}} to determine if two elements are equal, whereas overloads {{v|2,4}} use the given binary predicate {{tt|p}}.
  
 
===Parameters===
 
===Parameters===
Line 52: Line 52:
 
{{tt|std::equal}} may not be used to compare the ranges formed by the iterators from {{lc|std::unordered_set}}, {{lc|std::unordered_multiset}}, {{lc|std::unordered_map}}, or {{lc|std::unordered_multimap}} because the order in which the elements are stored in those containers may be different even if the two containers store the same elements.  
 
{{tt|std::equal}} may not be used to compare the ranges formed by the iterators from {{lc|std::unordered_set}}, {{lc|std::unordered_multiset}}, {{lc|std::unordered_map}}, or {{lc|std::unordered_multimap}} because the order in which the elements are stored in those containers may be different even if the two containers store the same elements.  
  
−
When comparing entire containers for equality, {{tt|operator{{==}} }} for the container are usually preferred.
+
When comparing entire containers for equality, {{tt|operator{{==}}}} for the corresponding container are usually preferred.
  
 
===Complexity===
 
===Complexity===

Revision as of 03:18, 9 July 2014

 
C++
 
Algorithm library
Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. ranges::copy, ranges::sort, ...
Execution policies (C++17)
Non-modifying sequence operations
Batch operations
(C++17)
Search operations
(C++11)                (C++11)(C++11)
equal

Modifying sequence operations
Copy operations
(C++11)
(C++11)
(C++11)
Swap operations
Transformation operations
Generation operations
Removing operations
Order-changing operations
(until C++17)(C++11)
(C++20)(C++20)
Sampling operations
(C++17)

Sorting and related operations
Partitioning operations
Sorting operations
Binary search operations
(on partitioned ranges)
Set operations (on sorted ranges)
Merge operations (on sorted ranges)
Heap operations
Minimum/maximum operations
(C++11)
(C++17)
Lexicographical comparison operations
(C++20)
Permutation operations
C library
Numeric operations
Operations on uninitialized memory
 
Defined in header <algorithm>
template< class InputIt1, class InputIt2 >

bool equal( InputIt1 first1, InputIt1 last1,

            InputIt2 first2 );
 (1)
template< class InputIt1, class InputIt2, class BinaryPredicate >

bool equal( InputIt1 first1, InputIt1 last1,

            InputIt2 first2, BinaryPredicate p );
 (2)
template< class InputIt1, class InputIt2 >

bool equal( InputIt1 first1, InputIt1 last1,

            InputIt2 first2, InputIt2 last2 );
 (3) (since C++14)
template< class InputIt1, class InputIt2, class BinaryPredicate >

bool equal( InputIt1 first1, InputIt1 last1,
            InputIt2 first2, InputIt2 last2,

            BinaryPredicate p );
 (4) (since C++14)
1,2) Returns true if the range [first1, last1) is equal to the range [first2, first2 + (last1 - first1), and false otherwise
3,4) Returns true if the range [first1, last1) is equal to the range [first2, last2), and false otherwise.

The two ranges are considered equal if, for every iterator i in the range [first1,last1), *i equals *(first2 + (i - first1)). The overloads (1,3) use operator== to determine if two elements are equal, whereas overloads (2,4) use the given binary predicate p.

Contents

Parameters

first1, last1 - the first range of the elements to compare
first2, last2 - the second range of the elements to compare
p - binary predicate which returns ​true if the elements should be treated as equal.

The signature of the predicate function should be equivalent to the following:

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

While the signature does not need to have const &, the function must not modify the objects passed to it and must be able to accept all values of type (possibly const) Type1 and Type2 regardless of value category (thus, Type1 & is not allowed, nor is Type1 unless for Type1 a move is equivalent to a copy(since C++11)).
The types Type1 and Type2 must be such that objects of types InputIt1 and InputIt2 can be dereferenced and then implicitly converted to Type1 and Type2 respectively. ​

Type requirements

Template:par req concept

Return value

3,4) If the length of the range [first1, last1) does not equal the length of the range [first2, last2), returns false

If the elements in the two ranges are equal, returns true.

Otherwise returns false.

Notes

std::equal may not be used to compare the ranges formed by the iterators from std::unordered_set, std::unordered_multiset, std::unordered_map, or std::unordered_multimap because the order in which the elements are stored in those containers may be different even if the two containers store the same elements.

When comparing entire containers for equality, operator== for the corresponding container are usually preferred.

Complexity

1,2) At most last1 - first1 applications of the predicate p
3,4) At most min(last1 - first1, last2 - first2) applications of the predicate p.
However, if InputIt1 and InputIt2 meet the requirements of Template:concept and last1 - first1 != last2 - first2 then no applications of the predicate p are made.


Possible implementation

First version 
template<class InputIt1, class InputIt2>
bool equal(InputIt1 first1, InputIt1 last1, 
           InputIt2 first2)
{
    for (; first1 != last1; ++first1, ++first2) {
        if (!(*first1 == *first2)) {
            return false;
        }
    }
    return true;
}
Second version 
template<class InputIt1, class InputIt2, class BinaryPredicate>
bool equal(InputIt1 first1, InputIt1 last1, 
           InputIt2 first2, BinaryPredicate p)
{
    for (; first1 != last1; ++first1, ++first2) {
        if (!p(*first1, *first2)) {
            return false;
        }
    }
    return true;
}

Example

The following code uses equal() to test if a string is a palindrome

Run this code
#include <algorithm>
#include <iostream>
#include <string>
 
bool is_palindrome(const std::string& s)
{
    return std::equal(s.begin(), s.begin() + s.size()/2, s.rbegin());
}
 
void test(const std::string& s)
{
    std::cout << "\"" << s << "\" "
        << (is_palindrome(s) ? "is" : "is not")
        << " a palindrome\n";
}
 
int main()
{
    test("radar");
    test("hello");
}

Output: 

"radar" is a palindrome
"hello" is not palindrome
(C++11)
 finds the first element satisfying specific criteria
(function template) [edit]
returns true if one range is lexicographically less than another
(function template) [edit]
finds the first position where two ranges differ
(function template) [edit]
searches for the first occurrence of a range of elements
(function template) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/algorithm/equal&oldid=72025"