operator==,!=,<,<=,>,>=,<=>(std::{{{1}}})

 

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)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Containers library

Sequence

array (C++11)

vector

vector<bool>

inplace_vector (C++26)

deque

forward_list (C++11)

list

Associative

set

multiset

map

multimap

Unordered associative

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

Adaptors

stack

queue

priority_queue

flat_set (C++23)

flat_multiset (C++23)

flat_map (C++23)

flat_multimap (C++23)

Views

span (C++20)

mdspan (C++23)

Tables

Iterator invalidation

Member function table

Non-member function table

 

Defined in header [[cpp/header/{{{1}}}|<{{{1}}}>]]
template< ... > bool operator==( const std::{{{1}}}<...>& lhs,                  const std::{{{1}}}<...>& rhs );	(1)
template< ... > bool operator!=( const std::{{{1}}}<...>& lhs,                  const std::{{{1}}}<...>& rhs );	(2)	(until C++20)
template< ... > bool operator<( const std::{{{1}}}<...>& lhs,                 const std::{{{1}}}<...>& rhs );	(3)	(until C++20)
template< ... > bool operator<=( const std::{{{1}}}<...>& lhs,                  const std::{{{1}}}<...>& rhs );	(4)	(until C++20)
template< ... > bool operator>( const std::{{{1}}}<...>& lhs,                 const std::{{{1}}}<...>& rhs );	(5)	(until C++20)
template< ... > bool operator>=( const std::{{{1}}}<...>& lhs,                  const std::{{{1}}}<...>& rhs );	(6)	(until C++20)
template< ... > /* see below */ operator<=>( const std::{{{1}}}<...>& lhs,                              const std::{{{1}}}<...>& rhs );	(7)	(since C++20)

Compares the contents of two {{{1}}}s.

1,2) Checks if the contents of lhs and rhs are equal, that is, they have the same number of elements and each element in lhs compares equal with the element in rhs at the same position.

3-6) Compares the contents of lhs and rhs lexicographically. The comparison is performed by a function equivalent to std::lexicographical_compare.

7) Compares the contents of lhs and rhs lexicographically. The comparison is performed as if by calling std::lexicographical_compare_three_way on two {{{1}}}s with a function object performing synthesized three-way comparison (see below). The return type is same as the result type of synthesized three-way comparison.

Given two const E lvalues lhs and rhs as left hand operand and right hand operand respectively (where E is T), synthesized three-way comparison is defined as:

• if std::three_way_comparable_with<E, E> is satisfied, equivalent to lhs <=> rhs;
• otherwise, if comparing two const E lvalues by operator< is well-formed and the result type satisfies boolean-testable, equivalent to

lhs < rhs ? std::weak_ordering::less :
rhs < lhs ? std::weak_ordering::greater :
            std::weak_ordering::equivalent

• otherwise, synthesized three-way comparison is not defined, and operator<=> does not participate in overload resolution.

The behavior of operator<=> is undefined if three_way_comparable_with or boolean-testable is satisfied but not modeled, or operator< is used but E and < do not establish a total order.

The <, <=, >, >=, and != operators are synthesized from operator<=> and operator== respectively.

(since C++20)

Parameters

lhs, rhs

-

{{{1}}}s whose contents to compare

Return value

1) true if the contents of the {{{1}}}s are equal, false otherwise.

2) true if the contents of the {{{1}}}s are not equal, false otherwise.

3) true if the contents of the lhs are lexicographically less than the contents of rhs, false otherwise.

4) true if the contents of the lhs are lexicographically less than or equal to the contents of rhs, false otherwise.

5) true if the contents of the lhs are lexicographically greater than the contents of rhs, false otherwise.

6) true if the contents of the lhs are lexicographically greater than or equal to the contents of rhs, false otherwise.

7) The relative order of the first pair of non-equivalent elements in lhs and rhs if there are such elements, lhs.size() <=> rhs.size() otherwise.

Complexity

1,2) Constant if lhs and rhs are of different size, otherwise linear in the size of the {{{1}}}.

3-7) Linear in the size of the {{{1}}}.

Example

Run this code

#include <cassert>
#include <forward_list>
 
int main()
{
    const std::forward_list
        a{1, 2, 3},
        b{1, 2, 3},
        c{7, 8, 9, 10};
 
    assert
    (""
        "Compare equal containers:" &&
        (a != b) == false &&
        (a == b) == true &&
        (a < b) == false &&
        (a <= b) == true &&
        (a > b) == false &&
        (a >= b) == true &&
        (a <=> b) != std::weak_ordering::less &&
        (a <=> b) != std::weak_ordering::greater &&
        (a <=> b) == std::weak_ordering::equivalent &&
        (a <=> b) >= 0 &&
        (a <=> b) <= 0 &&
        (a <=> b) == 0 &&
 
        "Compare non equal containers:" &&
        (a != c) == true &&
        (a == c) == false &&
        (a < c) == true &&
        (a <= c) == true &&
        (a > c) == false &&
        (a >= c) == false &&
        (a <=> c) == std::weak_ordering::less &&
        (a <=> c) != std::weak_ordering::equivalent &&
        (a <=> c) != std::weak_ordering::greater &&
        (a <=> c) < 0 &&
        (a <=> c) != 0 &&
        (a <=> c) <= 0 &&
    "");
}