Namespaces
Variants
Views
Actions

std::lexicographical_compare

From cppreference.com
< cpp‎ | algorithm
Revision as of 10:59, 18 August 2011 by P12 (Talk | contribs)

Template:cpp/algorithm/sidebar Template:ddcl list begin <tr class="t-dsc-header">

<td>
Defined in header <algorithm>
</td>

<td></td> <td></td> </tr> <tr class="t-dcl ">

<td >
template< class InputIterator1, class InputIterator2 >

bool lexicographical_compare( InputIterator1 first1, InputIterator1 last1,

                              InputIterator2 first2, InputIterator2 last2 );
</td>

<td > (1) </td> <td class="t-dcl-nopad"> </td> </tr> <tr class="t-dcl ">

<td >
template< class InputIterator1, class InputIterator2, class Compare >

bool lexicographical_compare( InputIterator1 first1, InputIterator1 last1,
                              InputIterator2 first2, InputIterator2 last2,

                              Compare comp );
</td>

<td > (2) </td> <td class="t-dcl-nopad"> </td> </tr> Template:ddcl list end

Checks if the first range Template:cpp is lexicographically less than the second range Template:cpp. The first version uses Template:cpp to compare the elements, the second version uses the given comparison function comp.

Lexicographical comparison is a operation with the following properties:

  • Two ranges are compared element by element.
  • The first mismatching element defines which range is lexicographically less or greater than the other.
  • If one range is a prefix of another, the shorter range is lexicographically less than the other.
  • If two ranges have equivalent elements and are of the same length, then the ranges are lexicographically equal.
  • An empty range is lexicographically less than any non-empty range.
  • Two empty ranges are lexicographically equal.

Contents

Parameters

first1, last1 - the first range of elements to examine
first2, last2 - the second range of elements to examine
comp - comparison function object (i.e. an object that satisfies the requirements of Compare) which returns true if the first argument is less than the second.

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

bool cmp(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 InputIterator1 and InputIterator2 can be dereferenced and then implicitly converted to both Type1 and Type2.

Return value

Template:cpp if the first range is lexicographically less than the second.

Complexity

At most Template:cpp applications of the comparison operation, where Template:cpp and Template:cpp.

Equivalent function

Template:eq fun cpp

Example

Template:example cpp