std::get(std::variant)

 

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::variant

メンバ関数

variant::variant

variant::~variant

variant::operator=

監視

variant::index

variant::valueless_by_exception

変更

variant::emplace

variant::swap

訪問

variant::visit (C++26)

非メンバ関数

visit (std::variant)

holds_alternative

get (std::variant)

get_if

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

swap (std::variant)

ヘルパークラス

monostate

bad_variant_access

variant_size

variant_alternative

hash<std::variant>

ヘルパーオブジェクト

variant_npos

 

ヘッダ <variant> で定義
	(1)	(C++17以降)
template< std::size_t I, class... Types > constexpr std::variant_alternative_t<I, std::variant<Types...>>&     get( std::variant<Types...>& v );
template< std::size_t I, class... Types > constexpr std::variant_alternative_t<I, std::variant<Types...>>&&     get( std::variant<Types...>&& v );
template< std::size_t I, class... Types > constexpr const std::variant_alternative_t<I, std::variant<Types...>>&     get( const std::variant<Types...>& v );
template< std::size_t I, class... Types > constexpr const std::variant_alternative_t<I, std::variant<Types...>>&&     get( const std::variant<Types...>&& v );
			(2)	(C++17以降)
template< class T, class... Types > constexpr T& get( std::variant<Types...>& v );
template< class T, class... Types > constexpr T&& get( std::variant<Types...>&& v );
template< class T, class... Types > constexpr const T& get( const std::variant<Types...>& v );
template< class T, class... Types > constexpr const T&& get( const std::variant<Types...>&& v );

1) インデックスベースの値アクセサ：v.index() = I の場合、v に格納されている値への参照を返します。それ以外の場合は、std::bad_variant_access をスローします。I がバリアントの有効なインデックスでない場合、呼び出しは不定形です。

2) 型ベースの値アクセサ：v が代替型 T を保持している場合、v に格納されている値への参照を返します。それ以外の場合は、std::bad_variant_access をスローします。T が Types... の一意の要素でない場合、呼び出しは不定形です。

テンプレートパラメータ

I	-	検索するインデックス
T	-	検索する一意の型
Types...	-	variant を形成する型

パラメータ

v

-

variant

戻り値

バリアントに格納されている値への参照。

例外

1,2) エラー時に std::bad_variant_access をスローします。

例

このコードを実行

#include <iostream>
#include <string>
#include <variant>
 
int main()
{
    std::variant<int, float> v{12}, w;
    std::cout << std::get<int>(v) << '\n';
    w = std::get<int>(v);
    w = std::get<0>(v); // same effect as the previous line
 
//  std::get<double>(v); // error: no double in [int, float]
//  std::get<3>(v);      // error: valid index values are 0 and 1
 
    try
    {
        w = 42.0f;
        std::cout << std::get<float>(w) << '\n'; // ok, prints 42
        w = 42;
        std::cout << std::get<float>(w) << '\n'; // throws
    }
    catch (std::bad_variant_access const& ex)
    {
        std::cout << ex.what() << ": w contained int, not float\n";
    }
}

実行結果の例

12
42
Unexpected index: w contained int, not float

関連項目

get_if (C++17)	インデックスまたは型（一意である場合）を指定して、ポインタが指す variant の値へのポインタを取得する。エラーの場合は null を返す (function template)
get(std::tuple) (C++11)	tuple は指定された要素にアクセスする (関数テンプレート)
get(std::array) (C++11)	array の要素にアクセスする (関数テンプレート)
get(std::pair) (C++11)	pairの要素にアクセスする (関数テンプレート)
get(std::ranges::subrange) (C++20)	std::ranges::subrange からイテレータまたはセンチネルを取得します (関数テンプレート)
get(std::complex) (C++26)	std::complex から実部または虚部への参照を取得します (関数テンプレート)