std::tuple

 

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)

 

std::tuple

メンバ関数

tuple::tuple

tuple::operator=

tuple::swap

非メンバ関数

make_tuple

tie

forward_as_tuple

tuple_cat

operator==operator!=operator<operator<=operator>operator>=operator<=> (C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20)

swap(std::tuple)

get(std::tuple)

ヘルパーコンセプト

tuple-like (C++23)

ヘルパークラス

tuple_size<std::tuple>

tuple_element<std::tuple>

uses_allocator<std::tuple>

basic_common_reference<std::tuple> (C++23)

common_type<std::tuple> (C++23)

formatter<std::tuple> (C++23)

ignore

推論ガイド(C++17)

 

ヘッダ <tuple> で定義
template< class... Types > class tuple;		(C++11以降)

クラステンプレート std::tuple は、異種の値の固定サイズコレクションです。std::pair の一般化です。

Types のすべての Ti に対して std::is_trivially_destructible<Ti>::value が true である場合、std::tuple のデストラクタは自明です。

プログラムが std::tuple の明示的または部分的な特殊化を宣言した場合、そのプログラムは診断を必要としない ill-formed です。

テンプレートパラメータ

Types...

-

タプルが格納する要素の型。空のリストもサポートされています。

メンバ関数

(コンストラクタ)	新しい tuple を構築する (public メンバ関数)
operator=	ある tuple の内容を別の tuple に代入する (public メンバ関数)
swap	2つの tuple の内容を入れ替える (public メンバ関数)

非メンバ関数

make_tuple (C++11)	引数型によって定義された型の tuple オブジェクトを生成する (関数テンプレート)
tie (C++11)	左辺値参照のタプルを生成するか、タプルを個々のオブジェクトにアンパックする (関数テンプレート)
forward_as_tuple (C++11)	転送参照の tuple を生成する (関数テンプレート)
tuple_cat (C++11)	任意の数のタプルを連結して tuple を生成する (関数テンプレート)
get(std::tuple) (C++11)	tuple は指定された要素にアクセスする (関数テンプレート)
operator==operator!=operator<operator<=operator>operator>=operator<=> (C++20で削除)(C++20で削除)(C++20で削除)(C++20で削除)(C++20で削除)(C++20)	タプル内の値を辞書順に比較する (関数テンプレート)
std::swap(std::tuple) (C++11)	std::swap アルゴリズムを特殊化する (関数テンプレート)

ヘルパーコンセプト

tuple-likepair-like (C++23)

型が *タプルプロトコル* を実装していることを指定する (std::get, std::tuple_element, std::tuple_size) (説明専用コンセプト*)

ヘルパークラス

std::tuple_size<std::tuple> (C++11)	のサイズを取得する tuple (クラステンプレート特殊化)
std::tuple_element<std::tuple> (C++11)	指定された要素の型を取得する (クラステンプレート特殊化)
std::uses_allocator<std::tuple> (C++11)	std::uses_allocator 型特性を特殊化する (クラステンプレート特殊化)
std::basic_common_reference<tuple-like> (C++23)	tuple と tuple-like 型の共通参照型を決定する (クラステンプレート特殊化)
std::common_type<tuple-like> (C++23)	tuple と tuple-like 型の共通型を決定する (クラステンプレート特殊化)
std::formatter<std::tuple> (C++23)	tuple の書式設定サポート (クラステンプレート特殊化)
ignore (C++11)	tie を使用して tuple をアンパックするときに要素をスキップするプレースホルダー (定数)

ヘルパー特殊化

template< class... Ts > constexpr bool enable_nonlocking_formatter_optimization<std::tuple<Ts...>>  = (enable_nonlocking_formatter_optimization<Ts> && ...);		(C++23から)

std::enable_nonlocking_formatter_optimization のこの特殊化は、各要素型がそれを有効にする場合に、tuple オブジェクトを印刷するための std::print および std::println の効率的な実装を可能にします。

ノート

タプルの「形状」— そのサイズ、要素の型、それらの型の順序 — はその型シグネチャの一部であるため、コンパイル時にすべて利用可能であり、他のコンパイル時情報にのみ依存することができます。これは、タプルに対する多くの条件付き操作 — 特に、条件付き先頭/末尾への追加とフィルタリング — が、条件がコンパイル時に評価できる場合にのみ可能であることを意味します。例えば、std::tuple<int, double, int> が与えられた場合、型でフィルタリングすることは可能ですが — 例えば、std::tuple<int, int> を返すなど — 各要素が正であるかどうかでフィルタリングすることはできません（タプルの実行時の値によって異なる型シグネチャを持つため）、すべての要素自体が constexpr でない限り。

回避策として、std::optional のタプルを扱うことができますが、実行時情報に基づいてサイズを調整する方法は依然としてありません。

N4387 (C++11の欠陥報告として適用) 以前は、関数はコピーリスト初期化を使用してタプルを返すことができませんでした

std::tuple<int, int> foo_tuple()
{
    return {1, -1};  // Error until N4387
    return std::tuple<int, int>{1, -1}; // Always works
    return std::make_tuple(1, -1); // Always works
}

例

このコードを実行

#include <iostream>
#include <stdexcept>
#include <string>
#include <tuple>
 
std::tuple<double, char, std::string> get_student(int id)
{
    switch (id)
    {
        case 0: return {3.8, 'A', "Lisa Simpson"};
        case 1: return {2.9, 'C', "Milhouse Van Houten"};
        case 2: return {1.7, 'D', "Ralph Wiggum"};
        case 3: return {0.6, 'F', "Bart Simpson"};
    }
 
    throw std::invalid_argument("id");
}
 
int main()
{
    const auto student0 = get_student(0);
    std::cout << "ID: 0, "
              << "GPA: " << std::get<0>(student0) << ", "
              << "grade: " << std::get<1>(student0) << ", "
              << "name: " << std::get<2>(student0) << '\n';
 
    const auto student1 = get_student(1);
    std::cout << "ID: 1, "
              << "GPA: " << std::get<double>(student1) << ", "
              << "grade: " << std::get<char>(student1) << ", "
              << "name: " << std::get<std::string>(student1) << '\n';
 
    double gpa2;
    char grade2;
    std::string name2;
    std::tie(gpa2, grade2, name2) = get_student(2);
    std::cout << "ID: 2, "
              << "GPA: " << gpa2 << ", "
              << "grade: " << grade2 << ", "
              << "name: " << name2 << '\n';
 
    // C++17 structured binding:
    const auto [gpa3, grade3, name3] = get_student(3);
    std::cout << "ID: 3, "
              << "GPA: " << gpa3 << ", "
              << "grade: " << grade3 << ", "
              << "name: " << name3 << '\n';
}

出力

ID: 0, GPA: 3.8, grade: A, name: Lisa Simpson
ID: 1, GPA: 2.9, grade: C, name: Milhouse Van Houten
ID: 2, GPA: 1.7, grade: D, name: Ralph Wiggum
ID: 3, GPA: 0.6, grade: F, name: Bart Simpson

欠陥報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 2796	C++11	std::tuple のデストラクタの自明性が未指定だった	指定された
LWG 3990	C++11	プログラムは明示的または std::tuple の部分特殊化を宣言できた	この場合、プログラムは ill-formed である （診断不要）

参照

• C++23標準 (ISO/IEC 14882:2024)

• 22.4 Tuples [tuple]

• C++20 standard (ISO/IEC 14882:2020)

• 20.5 Tuples [tuple]

• C++17 standard (ISO/IEC 14882:2017)

• 23.5 Tuples [tuple]

• C++14 standard (ISO/IEC 14882:2014)

• 20.4 Tuples [tuple]

• C++11 standard (ISO/IEC 14882:2011)

• 20.4 Tuples [tuple]

関連項目

pair	二項タプル、つまり値のペアを実装する (クラステンプレート)