operator==,!=,<,<=,>,>=,<=>(std::tuple)

来自cppreference.com
< cpp‎ | utility‎ | tuple
 
 
工具库
通用工具
日期和时间
函数对象
格式化库 (C++20)
(C++11)
关系运算符 (C++20 中弃用)
整数比较函数
(C++20)(C++20)(C++20)
(C++20)
swap 与类型运算
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
常用词汇类型
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)
初等字符串转换
(C++17)
(C++17)
 
std::tuple
成员函数
非成员函数
operator==operator!=operator<operator<=operator>operator>=operator<=>
(C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20)
推导指引(C++17)
辅助概念
(C++23)
辅助类
 
在标头 <tuple> 定义
(1)
template< class... TTypes, class... UTypes >

bool operator==( const std::tuple<TTypes...>& lhs,

                 const std::tuple<UTypes...>& rhs );
(C++11 起)
(C++14 前)
template< class... TTypes, class... UTypes >

constexpr bool operator==( const std::tuple<TTypes...>& lhs,

                           const std::tuple<UTypes...>& rhs );
(C++14 起)
(2)
template< class... TTypes, class... UTypes >

bool operator!=( const std::tuple<TTypes...>& lhs,

                 const std::tuple<UTypes...>& rhs );
(C++11 起)
(C++14 前)
template< class... TTypes, class... UTypes >

constexpr bool operator!=( const std::tuple<TTypes...>& lhs,

                           const std::tuple<UTypes...>& rhs );
(C++14 起)
(C++20 前)
(3)
template< class... TTypes, class... UTypes >

bool operator<( const std::tuple<TTypes...>& lhs,

                const std::tuple<UTypes...>& rhs );
(C++11 起)
(C++14 前)
template< class... TTypes, class... UTypes >

constexpr bool operator<( const std::tuple<TTypes...>& lhs,

                          const std::tuple<UTypes...>& rhs );
(C++14 起)
(C++20 前)
(4)
template< class... TTypes, class... UTypes >

bool operator<=( const std::tuple<TTypes...>& lhs,

                 const std::tuple<UTypes...>& rhs );
(C++11 起)
(C++14 前)
template< class... TTypes, class... UTypes >

constexpr bool operator<=( const std::tuple<TTypes...>& lhs,

                           const std::tuple<UTypes...>& rhs );
(C++14 起)
(C++20 前)
(5)
template< class... TTypes, class... UTypes >

bool operator>( const std::tuple<TTypes...>& lhs,

                const std::tuple<UTypes...>& rhs );
(C++11 起)
(C++14 前)
template< class... TTypes, class... UTypes >

constexpr bool operator>( const std::tuple<TTypes...>& lhs,

                          const std::tuple<UTypes...>& rhs );
(C++14 起)
(C++20 前)
(6)
template< class... TTypes, class... UTypes >

bool operator>=( const std::tuple<TTypes...>& lhs,

                 const std::tuple<UTypes...>& rhs );
(C++11 起)
(C++14 前)
template< class... TTypes, class... UTypes >

constexpr bool operator>=( const std::tuple<TTypes...>& lhs,

                           const std::tuple<UTypes...>& rhs );
(C++14 起)
(C++20 前)
template< class... TTypes, class... UTypes >

constexpr std::common_comparison_category_t<
    synth-three-way-result<TTypes, Elems>...>
    operator<=>( const std::tuple<TTypes...>& lhs,

                 const std::tuple<UTypes...>& rhs );
(7) (C++20 起)
template< class... TTypes, tuple-like UTuple >
constexpr bool operator==( const tuple<TTypes...>& lhs, const UTuple& rhs );
(8) (C++23 起)
template< class... TTypes, tuple-like UTuple >

constexpr std::common_comparison_category_t<
    synth-three-way-result<TTypes, /* Elems */>...>

    operator<=>( const tuple<TTypes...>& lhs, const UTuple& rhs );
(9) (C++23 起)
1,2)operator== 比较 tuple lhs 的每个元素和 tuple rhs 的对应元素。
1) 在每对对应元素都相等时返回 true
2) 返回 !(lhs == rhs)
如果 sizeof...(TTypes) 不等于 sizeof...(UTypes),或者 [0sizeof...(Types)) 中存在 i 使得 std::get<i>(lhs) == std::get<i>(rhs) 不是返回类型可转换到 bool (C++23 前)合法的表达式,那么程序非良构。

如果 [0sizeof...(Types)) 中存在 i 使得 decltype(std::get<i>(lhs) == std::get<i>(rhs)) 没有实现 boolean-testable,那么行为未定义。

(C++23 起)
3-6)operator< 以字典序比较 lhsrhs,即首先比较首元素,在等价时比较第二元素,还等价时再比较第三元素,以此类推。
3) 对于空 tuple,返回 false。对于非空 tuple,等价于
if (std::get<0>(lhs) < std::get<0>(rhs)) return true;

if (std::get<0>(rhs) < std::get<0>(lhs)) return false;
if (std::get<1>(lhs) < std::get<1>(rhs)) return true;
if (std::get<1>(rhs) < std::get<1>(lhs)) return false;
...

return std::get<N - 1>(lhs) < std::get<N - 1>(rhs);
4) 返回 !(rhs < lhs)
5) 返回 rhs < lhs
6) 返回 !(lhs < rhs)
7)synth-three-way 以字典序比较 lhsrhs,即首先比较首元素,在等价时比较第二元素,还等价时再比较第三元素,以此类推。

if (auto c = synth-three-way(std::get<0>(lhs), std::get<0>(rhs)); c != 0) return c;
if (auto c = synth-three-way(std::get<1>(lhs), std::get<1>(rhs)); c != 0) return c;
...
return synth-three-way(std::get<N - 1>(lhs), std::get<N - 1>(rhs));

8)(1),但区别在于 rhstuple-like 对象,并且 rhs 的元素数量改由 std::tuple_size_v<UTuple> 确定。此重载只能通过实参依赖查找找到。
9)(7),但区别在于 rhstuple-like 对象。/* Elems */ 表示包含 [0std::tuple_size_v<UTuple>) 中以升序排列的每个 i 对应的类型 std::tuple_element_t<i, UTuple> 的类型包。此重载只能通过实参依赖查找找到。

所有比较运算符是短路的;它们在确定结果所必须的比较之外不会访问其他的 tuple 元素。

<<=>>=!= 运算符分别从 operator<=>operator== 合成

(C++20 起)

参数

lhs, rhs - 要比较的 tuple

返回值

1,8) 在对于所有 [0sizeof...(Types)) 中的 i 都满足 std::get<i>(lhs) == std::get<i>(rhs) 时返回 true,否则返回 false。对两个空 tuple 返回 true
2) !(lhs == rhs)
3)lhs 中的首个不等价元素小于 rhs 中的时候是 true,如果 rhs 中的首个不等价元素小于 lhs 中的或无不等价元素时返回 false。对两个空 tuple 返回 false
4) !(rhs < lhs)
5) rhs < lhs
6) !(lhs < rhs)
7,9) 在存在不等价元素首对不等价元素间的关系时返回该关系,否则返回 std::strong_ordering::equal。对两个空 tuple 返回 std::strong_ordering::equal

示例

因为 operator< 有对 tuple 定义,所以能排序 tuple 的容器。

#include <algorithm>
#include <iostream>
#include <tuple>
#include <vector>
 
int main()
{
    std::vector<std::tuple<int, std::string, float>> v
    {
        {2, "baz", -0.1},
        {2, "bar", 3.14},
        {1, "foo", 10.1},
        {2, "baz", -1.1},
    };
    std::sort(v.begin(), v.end());
 
    for (const auto& p: v)
        std::cout << "{ " << std::get<0>(p)
                  << ", " << std::get<1>(p)
                  << ", " << std::get<2>(p)
                  << " }\n";
}

输出:

{ 1, foo, 10.1 }
{ 2, bar, 3.14 }
{ 2, baz, -1.1 }
{ 2, baz, -0.1 }

参阅

(C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20)
按字典序比较 pair 中的值
(函数模板)