std::tuple_element

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

工具庫

語言支援 型別支援（基本型別、RTTI） 庫特性測試宏 (C++20) 程式工具 變參函式 initializer_list (C++11) is_constant_evaluated (C++20) is_within_lifetime (C++26) source_location (C++20) 協程支援 (C++20) 契約支援 (C++26) 三路比較 three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)   is_eqis_ltis_lteq (C++20)(C++20)(C++20)   is_neqis_gtis_gteq (C++20)(C++20)(C++20)

通用工具 函式物件 位操作 (C++20) bitset hash (C++11) 關係運算符 (C++20 中棄用) rel_ops::operator!=rel_ops::operator>    rel_ops::operator<=rel_ops::operator>= 整數比較函式 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)   cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) 交換與型別操作 swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 常用詞彙型別 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23)

 

定義於標頭檔案 <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 中已棄用)

提供編譯時索引訪問類元組（tuple-like）型別元素的型別。

1) 主模板未定義。需要顯式（完全）或部分特化才能使型別成為類元組。

2-4) cv-限定型別的特化預設簡單地新增相應的cv-限定符。

std::tuple_element 與核心語言互動：它可以在類元組情況下提供結構化繫結支援。

(C++17 起)

特化

標準庫為標準庫型別提供以下特化

std::tuple_element<std::tuple> (C++11)	獲取指定元素的型別 (類模板特化)
std::tuple_element<std::pair> (C++11)	獲取 pair 元素的型別 (類模板特化)
std::tuple_element<std::array> (C++11)	獲得 array 元素的型別 (類模板特化)
std::tuple_element<std::ranges::subrange> (C++20)	獲取 std::ranges::subrange 的迭代器或哨兵的型別 (類模板特化)
std::tuple_element<std::complex> (C++26)	獲取 std::complex 的底層實數和虛數型別 (類模板特化)

使用者可以為程式定義的型別特化 std::tuple_element 以使其成為類元組。

在通常情況下，當 get 函式返回引用成員或對子物件的引用時，只需要自定義非 cv 限定型別的特化。

成員型別

成員型別	定義
型別	對於標準特化，類元組型別 T 的第 I 個元素的型別，其中 I 在 [​0​, std::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;
};
 
// A specialization of std::tuple_element for program-defined type Triple:
template<std::size_t I, typename T1, typename T2, typename T3>
    struct std::tuple_element<I, Triple<T1, T2, T3>>
    { static_assert(false, "Invalid index"); }; 
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), "Expected exactly 3 type names");
    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>; //< Program-defined type
    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)	將指定名稱繫結到初始化器的子物件或元組元素
tuple_size (C++11)	獲取類元組型別元素的數量 (類模板)
tuple_cat (C++11)	透過連線任意數量的 tuple 建立一個 tuple (函式模板)