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> で定義
template< class... Types > class variant;		(C++17以降)

クラステンプレート std::variant は、型安全な共用体 (union) を表します。

variant のインスタンスは、任意の時点で、その代替型のいずれかの値を保持するか、エラーの場合は値を保持しません（この状態を達成するのは困難です。valueless_by_exceptionを参照してください）。

共用体と同様に、variant があるオブジェクト型 T の値を保持する場合、その T オブジェクトは variant オブジェクト内にネストされます。

variant は、参照、配列、または型 void を保持することはできません。

variant は、同じ型を複数回保持することや、同じ型のcv修飾が異なるバージョンを保持することが許可されています。

集成体初期化中の共用体の振る舞いと一致して、デフォルト構築された variant は、その最初の代替型の値を保持します。ただし、その代替型がデフォルト構築可能でない場合を除きます（その場合、variant もデフォルト構築可能ではありません）。ヘルパークラス std::monostate を使用して、そのような variant をデフォルト構築可能にすることができます。

テンプレート引数なしで std::variant の定義をインスタンス化するプログラムは、不適格 (ill-formed) です。代わりに std::variant<std::monostate> を使用できます。

プログラムが std::variant の明示的または部分的な特殊化を宣言した場合、そのプログラムは不適格 (ill-formed) であり、診断は要求されません。

テンプレートパラメータ

型

-

この variant に格納されうる型。すべての型はデストラクター呼び出し可能 (Destructible) の要件を満たさなければなりません（特に、配列型と非オブジェクト型は許可されません）。

メンバ関数

(コンストラクタ)	variant オブジェクトを構築する (public member function)
(デストラクタ)	variant と、それに含まれる値を破棄する (public member function)
operator=	variant に代入する (public member function)
監視
index	variant が保持する代替型のゼロから始まるインデックスを返す (public member function)
valueless_by_exception	variant が無効な状態にあるかを確認する (public member function)
変更
emplace	variant 内に直接値を構築する (public member function)
swap	別の variant と交換する (public member function)
訪問
visit (C++26)	variant が保持する引数で、与えられたファンクタを呼び出す (public member function)

非メンバ関数

visit (C++17)	1つまたは複数の variant が保持する引数で、与えられたファンクタを呼び出す (function template)
holds_alternative (C++17)	variant が現在指定された型を保持しているかを確認する (function template)
get(std::variant) (C++17)	インデックスまたは型（型が一意である場合）を指定して variant の値を読み取る。エラーの場合は例外をスローする (function template)
get_if (C++17)	インデックスまたは型（一意である場合）を指定して、ポインタが指す variant の値へのポインタを取得する。エラーの場合は null を返す (function template)
operator==operator!=operator<operator<=operator>operator>=operator<=> (C++17)(C++17)(C++17)(C++17)(C++17)(C++17)(C++20)	variant オブジェクトを、その含まれる値として比較する (function template)
std::swap(std::variant) (C++17)	std::swap アルゴリズムを特殊化する (function template)

ヘルパークラス

monostate (C++17)	デフォルト構築不可能な型を持つ variant の最初の代替型として使用するためのプレースホルダ型 (class)
bad_variant_access (C++17)	variant の値への不正なアクセス時にスローされる例外 (class)
variant_sizevariant_size_v (C++17)	コンパイル時に variant の代替型のリストのサイズを取得する (class template) (variable template)
variant_alternativevariant_alternative_t (C++17)	コンパイル時にインデックスで指定された代替型の型を取得する (class template) (alias template)
std::hash<std::variant> (C++17)	std::variant のハッシュサポート (クラステンプレートの特殊化)

ヘルパーオブジェクト

variant_npos (C++17)

無効な状態にある variant のインデックス (constant)

ノート

機能テストマクロ	値	規格	機能
__cpp_lib_variant	201606L	(C++17)	std::variant: 型安全な共用体
	202102L	(C++23) (DR17)	std::variant から派生したクラスに対する std::visit
	202106L	(C++23) (DR20)	完全な constexpr std::variant
	202306L	(C++26)	メンバ visit

例

このコードを実行

#include <cassert>
#include <iostream>
#include <string>
#include <variant>
 
int main()
{
    std::variant<int, float> v, w;
    v = 42; // v contains int
    int i = std::get<int>(v);
    assert(42 == i); // succeeds
    w = std::get<int>(v);
    w = std::get<0>(v); // same effect as the previous line
    w = 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
    {
        std::get<float>(w); // w contains int, not float: will throw
    }
    catch (const std::bad_variant_access& ex)
    {
        std::cout << ex.what() << '\n';
    }
 
    using namespace std::literals;
 
    std::variant<std::string> x("abc");
    // converting constructors work when unambiguous
    x = "def"; // converting assignment also works when unambiguous
 
    std::variant<std::string, void const*> y("abc");
    // casts to void const* when passed a char const*
    assert(std::holds_alternative<void const*>(y)); // succeeds
    y = "xyz"s;
    assert(std::holds_alternative<std::string>(y)); // succeeds
}

実行結果の例

std::get: wrong index for variant

欠陥報告

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

DR	適用対象	公開された動作	正しい動作
LWG 2901	C++17	std::uses_allocator の特殊化が提供されていたが、 variant はアロケータを適切にサポートできない	特殊化は削除された
LWG 3990	C++17	プログラムが std::variant の明示的または 部分的な特殊化を宣言できていた	この場合、プログラムは不適格 (ill-formed) になる （診断は要求されない）
LWG 4141	C++17	variant オブジェクト内に 紛らわしかった	保持されるオブジェクトは ネストして格納するための要件

関連項目

in_placein_place_typein_place_indexin_place_tin_place_type_tin_place_index_t (C++17)	インプレース構築タグ (タグ)
optional (C++17)	オブジェクトを保持しているかもしれないし、していないかもしれないラッパー (クラステンプレート)
any (C++17)	任意の CopyConstructible な型のインスタンスを保持するオブジェクト (クラス)