std::tuple_element

来自cppreference.com
< cpp‎ | utility
 
 
 
在标头 <tuple> 定义
在标头 <array> 定义
在标头 <utility> 定义
在标头 <ranges> 定义
(C++20 起)
在标头 <complex> 定义
(C++26 起)
template< std::size_t I, class T >
struct tuple_element; // 不定义
(1) (C++11 起)
template< std::size_t I, class T >

struct tuple_element< I, const T > {
    using type = typename
        std::add_const<typename std::tuple_element<I, T>::type>::type;

};
(2) (C++11 起)
template< std::size_t I, class T >

struct tuple_element< I, volatile T > {
    using type = typename
        std::add_volatile<typename std::tuple_element<I, T>::type>::type;

};
(3) (C++11 起)
(C++20 弃用)
template< std::size_t I, class T >

struct tuple_element< I, const volatile T > {
    using type = typename
        std::add_cv<typename std::tuple_element<I, T>::type>::type;

};
(4) (C++11 起)
(C++20 弃用)

提供对元组式类型的元素类型的编译时索引访问。

1) 不定义主模板。为使类型成为元组式,需要进行显式(全)或部分特化。
2-4) 对 cv 限定类型的特化默认单纯地添加对应的 cv 限定符。

std::tuple_element 与核心语言交互:它能对元组式类型提供结构化绑定支持。

(C++17 起)

目录

[编辑] 特化

标准库为标准库类型提供下列特化:

获得指定元素的类型
(类模板特化) [编辑]
获得 pair 中元素的类型
(类模板特化) [编辑]
获得 array 元素的类型
(类模板特化) [编辑]
获得 std::ranges::subrange 的迭代器或哨位的类型
(类模板特化) [编辑]
获取 std::complex 的底层实部和虚部的数值类型
(类模板特化) [编辑]

用户可以对程序定义类型特化 std::tuple_size 以令它们为元组式。

get 函数返回引用成员或到子对象的引用的通常情况下,只需要自定义针对无 cv 限定类型的特化。

[编辑] 成员类型

成员类型 定义
type 对于标准特化,为元组式类型 T 的第 I 个元素的类型,其中 I[0std::tuple_size<T>::value)

[编辑] 辅助类型

在标头 <tuple> 定义
template< std::size_t I, class T >
using tuple_element_t = typename tuple_element<I, T>::type;
(C++14 起)

[编辑] 注解

功能特性测试 标准 功能特性
__cpp_lib_tuple_element_t 201402L (C++14) std::tuple_element_t

[编辑] 示例

#include <array>
#include <cstddef>
#include <iostream>
#include <ranges>
#include <tuple>
#include <type_traits>
#include <utility>
 
template<typename T1, typename T2, typename T3>
struct Triple
{
    T1 t1;
    T2 t2;
    T3 t3;
};
 
// std::tuple_element 针对程序定义类型 Triple 的特化:
template<std::size_t I, typename T1, typename T2, typename T3>
    struct std::tuple_element<I, Triple<T1, T2, T3>>
    { static_assert(false, "无效索引"); }; 
template<typename T1, typename T2, typename T3>
    struct std::tuple_element<0, Triple<T1, T2, T3>> { using type = T1; };
template<typename T1, typename T2, typename T3>
    struct std::tuple_element<1, Triple<T1, T2, T3>> { using type = T2; };
template<typename T1, typename T2, typename T3>
    struct std::tuple_element<2, Triple<T1, T2, T3>> { using type = T3; };
 
 
template<typename... Args> struct TripleTypes
{
    static_assert(3 == sizeof...(Args), "期待恰好 3 个类型名");
    template<std::size_t N>
    using type = typename std::tuple_element_t<N, Triple<Args...>>;
};
 
int main()
{
    TripleTypes<char, int, float>::type<1> i{42};
    std::cout << i << '\n';
 
    using Tri = Triple<int, char, short>; //< 程序定义类型
    static_assert(std::is_same_v<std::tuple_element_t<0, Tri>, int> &&
                  std::is_same_v<std::tuple_element_t<1, Tri>, char> &&
                  std::is_same_v<std::tuple_element_t<2, Tri>, short>);
 
    using Tuple = std::tuple<int, char, short>;
    static_assert(std::is_same_v<std::tuple_element_t<0, Tuple>, int> &&
                  std::is_same_v<std::tuple_element_t<1, Tuple>, char> &&
                  std::is_same_v<std::tuple_element_t<2, Tuple>, short>);
 
    using Array3 = std::array<int, 3>;
    static_assert(std::is_same_v<std::tuple_element_t<0, Array3>, int> &&
                  std::is_same_v<std::tuple_element_t<1, Array3>, int> &&
                  std::is_same_v<std::tuple_element_t<2, Array3>, int>);
 
    using Pair = std::pair<Tuple, Tri>;
    static_assert(std::is_same_v<std::tuple_element_t<0, Pair>, Tuple> &&
                  std::is_same_v<std::tuple_element_t<1, Pair>, Tri>);
 
    using Sub = std::ranges::subrange<int*, int*>;
    static_assert(std::is_same_v<std::tuple_element_t<0, Sub>, int*> &&
                  std::is_same_v<std::tuple_element_t<1, Sub>, int*>);
}

输出:

42

[编辑] 缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 出版时的行为 正确行为
LWG 2212 C++11 未在某些头文件中要求对 cv 类型的特化,这导致歧义 已要求

[编辑] 参阅

结构化绑定 (C++17) 绑定指定的名字到初始化式的子对象或元组元素[编辑]
获得元组式类型的元素数量
(类模板) [编辑]
(C++11)
通过连接任意数量的元组来创建一个tuple
(函数模板) [编辑]