std::tuple_size

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

ユーティリティライブラリ

言語サポート 型のサポート (基本型、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で非推奨)

コンパイル時定数式として、タプルライクな型の要素数にアクセスを提供します。

1) プライマリテンプレートは定義されていません。型をタプルライクにするには、明示的な（完全な）または部分的な特殊化が必要です。

2-4) cv修飾された型に対する特殊化は、デフォルトでは対応するcv非修飾バージョンからvalueを再利用します。

std::tuple_sizeはコア言語と連携します。タプルライクなケースでは構造化束縛をサポートできます。 (2-4) はSFINAEフレンドリーです。もしstd::tuple_size<T>::valueが評価されないオペランドとして扱われた場合にill-formedであるならば、それらはメンバ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 (クラステンプレート特殊化)
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のすべての特殊化は、あるNに対してstd::integral_constant<std::size_t, N>という基底特性でUnaryTypeTraitを満たします。

ユーザは、プログラム定義型をタプルライクにするために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 [static]

標準特殊化の場合、タプルライクな型Tの要素数 (公開静的メンバ定数)

メンバ関数

operator std::size_t	オブジェクトを std::size_t に変換し、value を返します。 (public member function)
operator() (C++14)	value を返します。 (public member function)

メンバ型

型	定義
value_type	std::size_t
type	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++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 2212	C++11	cv型に対する特殊化が一部のヘッダーで要求されておらず、曖昧さを生じていた。	必要

関連項目

構造化束縛 (C++17)	指定された名前を初期化子のサブオブジェクトまたはタプル要素に束縛します
tuple_element (C++11)	タプルライクな型の要素型を取得する (クラステンプレート)
tuple_cat (C++11)	任意の数のタプルを連結して tuple を生成する (関数テンプレート)