std::mismatch (3) - Linux Manuals

std::mismatch: std::mismatch

Command to display std::mismatch manual in Linux: $ man 3 std::mismatch

NAME

std::mismatch - std::mismatch

Synopsis

Defined in header <algorithm>
template< class InputIt1, class InputIt2 >
std::pair<InputIt1,InputIt2> (until C++20)
mismatch( InputIt1 first1, InputIt1 last1,
InputIt2 first2 );
template< class InputIt1, class InputIt2 >
constexpr std::pair<InputIt1,InputIt2> (since C++20)
mismatch( InputIt1 first1, InputIt1 last1,
InputIt2 first2 );
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 >
std::pair<ForwardIt1,ForwardIt2> (2) (since C++17)
mismatch( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1,
ForwardIt2 first2 );
template< class InputIt1, class InputIt2, class BinaryPredicate >
std::pair<InputIt1,InputIt2>
mismatch( InputIt1 first1, InputIt1 last1, (until C++20)
InputIt2 first2,
BinaryPredicate p );
template< class InputIt1, class InputIt2, class BinaryPredicate >
constexpr std::pair<InputIt1,InputIt2>
mismatch( InputIt1 first1, InputIt1 last1, (since C++20)
InputIt2 first2,
BinaryPredicate p );
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class BinaryPredicate >
std::pair<ForwardIt1,ForwardIt2>
mismatch( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1, (4) (since C++17)
ForwardIt2 first2,
BinaryPredicate p ); (1)
template< class InputIt1, class InputIt2 >
std::pair<InputIt1,InputIt2> (since C++14)
mismatch( InputIt1 first1, InputIt1 last1, (until C++20)
InputIt2 first2, InputIt2 last2 );
template< class InputIt1, class InputIt2 >
constexpr std::pair<InputIt1,InputIt2> (3) (since C++20)
mismatch( InputIt1 first1, InputIt1 last1,
InputIt2 first2, InputIt2 last2 );
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 >
std::pair<ForwardIt1,ForwardIt2> (6) (since C++17)
mismatch( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1,
ForwardIt2 first2, ForwardIt2 last2 );
template< class InputIt1, class InputIt2, class BinaryPredicate >
std::pair<InputIt1,InputIt2> (5) (since C++14)
mismatch( InputIt1 first1, InputIt1 last1, (until C++20)
InputIt2 first2, InputIt2 last2,
BinaryPredicate p );
template< class InputIt1, class InputIt2, class BinaryPredicate >
constexpr std::pair<InputIt1,InputIt2>
mismatch( InputIt1 first1, InputIt1 last1, (7) (since C++20)
InputIt2 first2, InputIt2 last2,
BinaryPredicate p );
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class BinaryPredicate >
std::pair<ForwardIt1,ForwardIt2>
mismatch( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1, (8) (since C++17)
ForwardIt2 first2, ForwardIt2 last2,
BinaryPredicate p );

Returns the first mismatching pair of elements from two ranges: one defined by [first1, last1) and another defined by [first2,last2). If last2 is not provided (overloads (1-4)), it denotes first2 + (last1 - first1).
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. This overload only participates in overload resolution if std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is true

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.
                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);
p - 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.
-
BinaryPredicate must meet the requirements of BinaryPredicate.

Return value

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

If no mismatches are found when the comparison reaches last1, the pair holds last1 and the corresponding iterator from the second range. The behavior is undefined if the second range is shorter than the first range. (until C++14)
If no mismatches are found when the comparison reaches last1 or last2, whichever happens first, the pair holds the end iterator and the corresponding iterator from the other range. (since C++14)

Complexity

1-4) At most last1 - first1 applications of operator== or the predicate p
5-8) At most min(last1 - first1, last2 - first2) applications of operator== or 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

First version

  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);
  }

Second version

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

Third version

  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);
  }

Fourth version

  template<class InputIt1, class InputIt2, class BinaryPredicate>
  std::pair<InputIt1, InputIt2>
      mismatch(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, BinaryPredicate 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 <iostream>
  #include <string>
  #include <algorithm>

  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