std::tuple_size

 

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)

 

定義於標頭檔案 <array>
定義於標頭檔案 <tuple>
在標頭檔案 <utility> 中定義
定義於標頭檔案 <ranges>		(C++20 起)
定義於標頭檔案 <complex>		(C++26 起)
template< class T > struct tuple_size; // 未定義	(1)	(C++11 起)
template< class T > struct tuple_size< const T >     : std::integral_constant<std::size_t, std::tuple_size<T>::value> {};	(2)	(C++11 起)
template< class T > struct tuple_size< volatile T >     : std::integral_constant<std::size_t, std::tuple_size<T>::value> {};	(3)	(C++11 起) (C++20 中已棄用)
template< class T > struct tuple_size< const volatile T >     : std::integral_constant<std::size_t, std::tuple_size<T>::value> {};	(4)	(C++11 起) (C++20 中已棄用)

在編譯時以常量表達式的形式提供對類元組（tuple-like）型別中元素數量的訪問。

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

2-4) cv 限定型別的特化預設重用對應 cv 非限定版本的 value。

std::tuple_size 與核心語言互動：它可以在類元組情況下提供結構化繫結支援。 (2-4) 是 SFINAE 友好的：如果 std::tuple_size<T>::value 在被視為未求值運算元時格式錯誤，它們將不提供成員 value。訪問檢查的執行方式如同在與 tuple_size 和 T 無關的上下文中進行。只考慮表示式的直接上下文的有效性。這允許 #include <utility>   struct X { int a, b; }; const auto [x, y] = X(); // structured binding declaration first attempts // tuple_size<const X> which attempts to use tuple_size<X>::value, // then soft error encountered, binds to public data members

(C++17 起)

特化

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

std::tuple_size<std::tuple> (C++11)	獲取 tuple 的大小 一個 tuple (類模板特化)
std::tuple_size<std::pair> (C++11)	獲取 pair 的大小 (類模板特化)
std::tuple_size<std::array> (C++11)	獲得 array 的大小 (類模板特化)
std::tuple_size<std::ranges::subrange> (C++20)	獲取 std::ranges::subrange 的大小 (類模板特化)
std::tuple_size<std::complex> (C++26)	獲取 std::complex 的大小 (類模板特化)

所有 std::tuple_size 的特化都滿足 一元型別特性 (UnaryTypeTrait)，其基本特性為 std::integral_constant<std::size_t, N>，其中 N 為某個值。

使用者可以為程式定義型別特化 std::tuple_size 以使它們成為類元組。程式定義的特化必須滿足上述要求。

通常只需要為 cv 非限定型別定製特化。

輔助變數模板

定義於標頭檔案 <tuple>
template< class T > constexpr std::size_t tuple_size_v = tuple_size<T>::value;		(C++17 起)

繼承自 std::integral_constant

成員常量

value [靜態]

對於標準特化，類元組型別 T 中的元素數量 (public static 成員常量)

成員函式

operator std::size_t	將物件轉換為 std::size_t，返回 value (公開成員函式)
operator() (C++14)	返回 value (公開成員函式)

成員型別

型別	定義
value_type	std::size_t
型別	std::integral_constant<std::size_t, value>

示例

執行此程式碼

#include <array>
#include <cstddef>
#include <ranges>
#include <tuple>
#include <utility>
 
template<class T, std::size_t Size> struct Arr { T data[Size]; };
 
// Program-defined specialization of std::tuple_size:
template<class T, std::size_t Size> struct std::tuple_size<Arr<T, Size>>
    : public integral_constant<std::size_t, Size> {};
 
int main()
{
    using tuple1 = std::tuple<int, char, double>;
    static_assert(3 == std::tuple_size_v<tuple1>); // uses using template (C++17)
 
    using array3x4 = std::array<std::array<int, 3>, 4>;
    static_assert(4 == std::tuple_size<array3x4>{}); // uses operator std::size_t
 
    using pair = std::pair<tuple1, array3x4>;
    static_assert(2 == std::tuple_size<pair>()); // uses operator()
 
    using sub = std::ranges::subrange<char*, char*>;
    static_assert(2 == std::tuple_size<sub>::value);
 
    using Arr5 = Arr<int, 5>;
    static_assert(5 == std::tuple_size_v<Arr5>);
}

缺陷報告

下列更改行為的缺陷報告追溯地應用於以前出版的 C++ 標準。

缺陷報告	應用於	釋出時的行為	正確的行為
LWG 2212	C++11	某些標頭檔案中不需要 cv 型別的特化，導致歧義	需要

參見

結構化繫結 (C++17)	將指定的名稱繫結到初始化器的子物件或元組元素
tuple_element (C++11)	獲取類元組型別的元素型別 (類模板)
tuple_cat (C++11)	透過連線任意數量的 tuple 建立一個 tuple (函式模板)