std::lexicographical_compare

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Technical specifications

Symbols index

External libraries

 

Algorithm library

Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. ranges::copy, ranges::sort, ...
Execution policies (C++17)
is_execution_policy (C++17)	execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)(C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
Non-modifying sequence operations
all_ofany_ofnone_of (C++11)(C++11)(C++11) for_each for_each_n (C++17)	countcount_if mismatch equal adjacent_find	search search_n lexicographical_compare lexicographical_compare_three_way (C++20)	findfind_iffind_if_not (C++11) find_end find_first_of
Modifying sequence operations
copycopy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) shift_leftshift_right (C++20)(C++20) transform	fill fill_n generate generate_n swap iter_swap swap_ranges sample (C++17)	removeremove_if replacereplace_if reverse rotate unique random_shuffle (until C++17)	remove_copyremove_copy_if replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy shuffle (C++11)
Partitioning operations
is_partitioned (C++11) partition_point (C++11)	partition partition_copy (C++11)	stable_partition
Sorting operations
is_sorted (C++11) is_sorted_until (C++11)	sort stable_sort	partial_sort partial_sort_copy	nth_element
Binary search operations
lower_bound	upper_bound	binary_search	equal_range
Set operations (on sorted ranges)
merge inplace_merge	set_difference set_intersection	set_symmetric_difference set_union	includes
Heap operations
is_heap (C++11) is_heap_until (C++11)	make_heap sort_heap	push_heap pop_heap
Minimum/maximum operations
max max_element	min min_element	minmax (C++11) minmax_element (C++11)	clamp (C++17)
Permutations
is_permutation (C++11)	next_permutation	prev_permutation
Numeric operations
iota (C++11) inner_product adjacent_difference	accumulate reduce (C++17) transform_reduce (C++17)	transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)	partial_sum inclusive_scan (C++17) exclusive_scan (C++17)
Operations on uninitialized storage
uninitialized_copy uninitialized_move (C++17) uninitialized_fill	uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)
C library
qsort	bsearch

 

Defined in header <algorithm>
	(1)
template< class InputIt1, class InputIt2 > bool lexicographical_compare( InputIt1 first1, InputIt1 last1,                               InputIt2 first2, InputIt2 last2 );			(until C++20)
template< class InputIt1, class InputIt2 > constexpr bool lexicographical_compare( InputIt1 first1, InputIt1 last1,                                         InputIt2 first2, InputIt2 last2 );			(since C++20)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 > bool lexicographical_compare( ExecutionPolicy&& policy,                               ForwardIt1 first1, ForwardIt1 last1,                               ForwardIt2 first2, ForwardIt2 last2 );		(2)	(since C++17)
		(3)
template< class InputIt1, class InputIt2, class Compare > bool lexicographical_compare( InputIt1 first1, InputIt1 last1,                               InputIt2 first2, InputIt2 last2, Compare comp );				(until C++20)
template< class InputIt1, class InputIt2, class Compare > constexpr bool lexicographical_compare( InputIt1 first1, InputIt1 last1,                                         InputIt2 first2, InputIt2 last2,                                         Compare comp );				(since C++20)
template< class ExecutionPolicy,           class ForwardIt1, class ForwardIt2, class Compare > bool lexicographical_compare( ExecutionPolicy&& policy,                               ForwardIt1 first1, ForwardIt1 last1,                               ForwardIt2 first2, ForwardIt2 last2,                               Compare comp );			(4)	(since C++17)

Checks if the first range [first1, last1) is lexicographically less than the second range [first2, last2).

1) Elements are compared using operator<.

3) Elements are compared using the given binary comparison function comp.

2,4) Same as (1,3), but executed according to policy. These overloads do not participate in overload resolution unless

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)

Lexicographical comparison is an 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.

Parameters

first1, last1	-	the first range of elements to examine
first2, last2	-	the second range of elements to examine
policy	-	the execution policy to use. See execution policy for details.
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 InputIt1 and InputIt2 can be dereferenced and then implicitly converted to both Type1 and Type2.
Type requirements
- InputIt1, InputIt2 must meet the requirements of LegacyInputIterator.
- ForwardIt1, ForwardIt2 must meet the requirements of LegacyForwardIterator.
- Compare must meet the requirements of Compare.

Return value

true if the first range is lexicographically less than the second, otherwise false.

Complexity

Given \(\scriptsize N_1\)N₁ as std::distance(first1, last1) and \(\scriptsize N_2\)N₂ as std::distance(first2, last2):

1,2) At most \(\scriptsize min(N_1,N_2)\)min(N₁,N₂) comparisons using operator<.

3,4) At most \(\scriptsize min(N_1,N_2)\)min(N₁,N₂) applications of the comparison function comp.

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

lexicographical_compare (1)
template<class InputIt1, class InputIt2> bool lexicographical_compare(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2) { for (; (first1 != last1) && (first2 != last2); ++first1, (void) ++first2) { if (*first1 < *first2) return true; if (*first2 < *first1) return false; }   return (first1 == last1) && (first2 != last2); }
lexicographical_compare (3)
template<class InputIt1, class InputIt2, class Compare> bool lexicographical_compare(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, Compare comp) { for (; (first1 != last1) && (first2 != last2); ++first1, (void) ++first2) { if (comp(*first1, *first2)) return true; if (comp(*first2, *first1)) return false; }   return (first1 == last1) && (first2 != last2); }

Example

Run this code

#include <algorithm>
#include <iostream>
#include <random>
#include <vector>
 
void print(std::vector<char> const& v, auto suffix)
{
    for (char c : v)
        std::cout << c << ' ';
    std::cout << suffix;
}
 
int main()
{
    std::vector<char> v1{'a', 'b', 'c', 'd'};
    std::vector<char> v2{'a', 'b', 'c', 'd'};
 
    for (std::mt19937 g{std::random_device{}()};
         !std::lexicographical_compare(v1.begin(), v1.end(),
                                       v2.begin(), v2.end());)
    {
        print(v1, ">= ");
        print(v2, '\n');
 
        std::shuffle(v1.begin(), v1.end(), g);
        std::shuffle(v2.begin(), v2.end(), g);
    }
 
    print(v1, "<  ");
    print(v2, '\n');
}

Possible output:

a b c d >= a b c d 
d a b c >= c b d a 
b d a c >= a d c b 
a c d b <  c d a b

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR	Applied to	Behavior as published	Correct behavior
LWG 142	C++98	at most \(\scriptsize min(N_1,N_2)\)min(N1,N2) comparisons were allowed, but that is not possible (equality is determined by 2 comparisons)	doubled the limit
LWG 1205	C++98	the results of lexicographical comparisons involving empty ranges were unclear	made clear

See also

equal	determines if two sets of elements are the same (function template)
lexicographical_compare_three_way (C++20)	compares two ranges using three-way comparison (function template)
ranges::lexicographical_compare (C++20)	returns true if one range is lexicographically less than another (niebloid)