std::mismatch

From cppreference.com
< cpp‎ | algorithm
 
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)
mismatch

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 >

std::pair<InputIt1, InputIt2>
    mismatch( InputIt1 first1, InputIt1 last1,

              InputIt2 first2 );
 (1) (constexpr since C++20)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 >

std::pair<ForwardIt1, ForwardIt2>
    mismatch( ExecutionPolicy&& policy,
              ForwardIt1 first1, ForwardIt1 last1,

              ForwardIt2 first2 );
 (2) (since C++17)
template< class InputIt1, class InputIt2, class BinaryPred >

std::pair<InputIt1, InputIt2>
    mismatch( InputIt1 first1, InputIt1 last1,

              InputIt2 first2, BinaryPred p );
 (3) (constexpr since C++20)
template< class ExecutionPolicy,

          class ForwardIt1, class ForwardIt2, class BinaryPred >
std::pair<ForwardIt1, ForwardIt2>
    mismatch( ExecutionPolicy&& policy,
              ForwardIt1 first1, ForwardIt1 last1,

              ForwardIt2 first2, BinaryPred p );
 (4) (since C++17)
template< class InputIt1, class InputIt2 >

std::pair<InputIt1, InputIt2>
    mismatch( InputIt1 first1, InputIt1 last1,

              InputIt2 first2, InputIt2 last2 );
 (5) (since C++14)
(constexpr since C++20)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 >

std::pair<ForwardIt1, ForwardIt2>
    mismatch( ExecutionPolicy&& policy,
              ForwardIt1 first1, ForwardIt1 last1,

              ForwardIt2 first2, ForwardIt2 last2 );
 (6) (since C++17)
template< class InputIt1, class InputIt2, class BinaryPred >

std::pair<InputIt1, InputIt2>
    mismatch( InputIt1 first1, InputIt1 last1,

              InputIt2 first2, InputIt2 last2, BinaryPred p );
 (7) (since C++14)
(constexpr since C++20)
template< class ExecutionPolicy,

          class ForwardIt1, class ForwardIt2, class BinaryPred >
std::pair<ForwardIt1, ForwardIt2>
    mismatch( ExecutionPolicy&& policy,
              ForwardIt1 first1, ForwardIt1 last1,

              ForwardIt2 first2, ForwardIt2 last2, BinaryPred p );
 (8) (since C++17)

Returns a pair of iterators to the first mismatching of elements from [first1, last1) and a range starting from first2:

  • For overloads (1-4), the second range has std::distance(first1, last1) elements.
  • For overloads (5-8), the second range is [first2, last2).
  • If std::distance(first1, last1) and std::distance(first2, last2) are different, the comparison stops when last1 or last2 is reached.
1,5) Elements are compared using operator==.
3,7) Elements are compared using the given binary predicate p.
2,4,6,8) Same as (1,3,5,7), but executed according to policy.
These overloads participate in overload resolution only if

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is true.

(until C++20)

std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> is true.

(since C++20)

Parameters

first1, last1 - the first range of the elements
first2, last2 - the second range of the elements
policy - the execution policy to use. See execution policy for details.
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
-
InputIt1 must meet the requirements of LegacyInputIterator.
-
InputIt2 must meet the requirements of LegacyInputIterator.
-
ForwardIt1 must meet the requirements of LegacyForwardIterator.
-
ForwardIt2 must meet the requirements of LegacyForwardIterator.
-
BinaryPred must meet the requirements of BinaryPredicate.

Return value

std::pair with iterators to the first two non-equal elements.

If last1 is reached, the second iterator in the pair is the std::distance(first1, last1)
th iterator after first2.

For overloads (5-8), if last2 is reached, the first iterator in the pair is the std::distance(first2, last2)
th iterator after first1.

Complexity

Given N
1 as std::distance(first1, last1) and N
2 as std::distance(first2, last2):

1,2) At most N
1 comparisons using operator==.
3,4) At most N
1 applications of the predicate p.
5,6) At most min(N
1,N
2) comparisons using operator==.
7,8) At most min(N
1,N
2) applications of the predicate p.

Exceptions

The overloads with a template parameter named ExecutionPolicy report errors as follows:

  • If execution of a function invoked as part of the algorithm throws an exception and ExecutionPolicy is one of the standard policies, std::terminate is called. For any other ExecutionPolicy, the behavior is implementation-defined.
  • If the algorithm fails to allocate memory, std::bad_alloc is thrown.

Possible implementation

mismatch (1) 
template<class InputIt1, class InputIt2>
std::pair<InputIt1, InputIt2>
    mismatch(InputIt1 first1, InputIt1 last1, InputIt2 first2)
{
    while (first1 != last1 && *first1 == *first2)
        ++first1, ++first2;
 
    return std::make_pair(first1, first2);
}
mismatch (3) 
template<class InputIt1, class InputIt2, class BinaryPred>
std::pair<InputIt1, InputIt2>
    mismatch(InputIt1 first1, InputIt1 last1, InputIt2 first2, BinaryPred p)
{
    while (first1 != last1 && p(*first1, *first2))
        ++first1, ++first2;
 
    return std::make_pair(first1, first2);
}
mismatch (5) 
template<class InputIt1, class InputIt2>
std::pair<InputIt1, InputIt2>
    mismatch(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2)
{
    while (first1 != last1 && first2 != last2 && *first1 == *first2)
        ++first1, ++first2;
 
    return std::make_pair(first1, first2);
}
mismatch (7) 
template<class InputIt1, class InputIt2, class BinaryPred>
std::pair<InputIt1, InputIt2>
    mismatch(InputIt1 first1, InputIt1 last1,
             InputIt2 first2, InputIt2 last2, BinaryPred p)
{
    while (first1 != last1 && first2 != last2 && p(*first1, *first2))
        ++first1, ++first2;
 
    return std::make_pair(first1, first2);
}

Example

This program determines the longest substring that is simultaneously found at the very beginning of the given string and at the very end of it, in reverse order (possibly overlapping).

Run this code
#include <algorithm>
#include <iostream>
#include <string>
 
std::string mirror_ends(const std::string& in)
{
    return std::string(in.begin(),
                       std::mismatch(in.begin(), in.end(), in.rbegin()).first);
}
 
int main()
{
    std::cout << mirror_ends("abXYZba") << '\n'
              << mirror_ends("abca") << '\n'
              << mirror_ends("aba") << '\n';
}

Output: 

ab
a
aba

See also

 determines if two sets of elements are the same
(function template)
(C++11)
 finds the first element satisfying specific criteria
(function template)
returns true if one range is lexicographically less than another
(function template)
searches for the first occurrence of a range of elements
(function template)
(C++20)
 finds the first position where two ranges differ
(niebloid)
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/algorithm/mismatch&oldid=170579"