Namespaces
Variants
Views
Actions

Difference between revisions of "Template:cpp/container/operator cmp"

From cppreference.com
m (→‎Synopsis: +(since C++11) for `array` and `forward_list`, others stay unchanged)
m (→‎Synopsis: +(since C++11) in (1) in vector+array branch too)
Line 5: Line 5:
 
{{dcl header|{{cpp/container/get_header|{{{1}}}}}}}
 
{{dcl header|{{cpp/container/get_header|{{{1}}}}}}}
 
{{#switch:{{{1}}}|array|vector=
 
{{#switch:{{{1}}}|array|vector=
−
{{dcl rev multi|num=1
+
{{dcl rev multi|num=1|since1={{cpp/std|{{{1|}}}}}
 
|until1=c++20|dcl1=
 
|until1=c++20|dcl1=
 
template< {{#var:types}} >
 
template< {{#var:types}} >

Revision as of 13:40, 6 December 2023

 
C++
 
Containers library
 
Defined in header [[cpp/header/{{{1}}}|<{{{1}}}>]]
template< ... >

bool operator==( const std::{{{1}}}<...>& lhs,

                 const std::{{{1}}}<...>& rhs );
 (1) (since {std})
template< ... >

bool operator!=( const std::{{{1}}}<...>& lhs,

                 const std::{{{1}}}<...>& rhs );
 (2) (since {std})
(until C++20)
template< ... >

bool operator<( const std::{{{1}}}<...>& lhs,

                const std::{{{1}}}<...>& rhs );
 (3) (since {std})
(until C++20)
template< ... >

bool operator<=( const std::{{{1}}}<...>& lhs,

                 const std::{{{1}}}<...>& rhs );
 (4) (since {std})
(until C++20)
template< ... >

bool operator>( const std::{{{1}}}<...>& lhs,

                const std::{{{1}}}<...>& rhs );
 (5) (since {std})
(until C++20)
template< ... >

bool operator>=( const std::{{{1}}}<...>& lhs,

                 const std::{{{1}}}<...>& rhs );
 (6) (since {std})
(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: 

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)

Contents

Parameters

lhs, rhs - {{{1}}}s whose contents to compare
Templated information. See page source.

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


Retrieved from "https://en.cppreference.com/mwiki/index.php?title=Template:cpp/container/operator_cmp&oldid=165129"