std::variant

 

C++

言語

標準ライブラリヘッダ

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

名前付き要件

言語サポートライブラリ

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

診断ライブラリ

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

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ (C++20)

アルゴリズムライブラリ

数値演算ライブラリ

ローカライゼーションライブラリ

入出力ライブラリ

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

正規表現ライブラリ (C++11)

アトミック操作ライブラリ (C++11)

スレッドサポートライブラリ (C++11)

技術仕様書

 

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

言語サポート 型サポート (基本型、RTTI、型特性) ライブラリの機能テストマクロ (C++20) 動的メモリ管理 プログラムユーティリティ エラー処理 コルーチンサポート (C++20) 可変長引数関数 launder (C++17) initializer_list (C++11) source_location (C++20) 三方比較 (C++20) 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_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

汎用ユーティリティ 日付と時間 関数オブジェクト 書式化ライブラリ (C++20) bitset hash (C++11) integer_sequence (C++14) 関係演算子 (C++20で非推奨) rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>= 整数比較関数 cmp_equalcmp_not_equalcmp_lesscmp_greatercmp_less_thancmp_greater_than (C++20)(C++20)(C++20)(C++20)(C++20)(C++20) in_range (C++20) スワップと型操作 swap ranges::swap (C++20) exchange (C++14) declval (C++11) forward (C++11) move (C++11) move_if_noexcept (C++11) as_const (C++17) 一般的な語彙の型 pair tuple (C++11) apply (C++17) make_from_tuple (C++17) optional (C++17) any (C++17) variant (C++17) 初等文字列変換 to_chars (C++17) from_chars (C++17) chars_format (C++17)

 

std::variant

メンバ関数

variant::variant

variant::~variant

variant::operator=

観察

variant::index

variant::valueless_by_exception

変更

variant::emplace

variant::swap

非メンバ関数

visit

holds_alternative

get

get_if

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

swap

ヘルパークラス

monostate

bad_variant_access

variant_size

variant_alternative

hash

ヘルパーオブジェクト

variant_npos

 

<tbody> </tbody>

ヘッダ <variant> で定義
template <class... Types> class variant;		(C++17以上)

クラステンプレート std::variant は型安全な union を表します。 std::variant のインスタンスは任意の時点でその型の選択肢のいずれかの値を保持します。 また、エラーが発生した場合は値を保持しないこともあります (この状態を得るのは簡単ではありません。 valueless_by_exception を参照してください)。

union と同様に、 variant が何らかのオブジェクト型 T の値を保持している場合、 T のオブジェクト表現は variant 自身のオブジェクト表現内に直接確保されます。 variant が追加の (動的) メモリを確保することはありません。

variant は参照、配列、および void 型を保持することはできません。 空の variant もまた ill-formed です (代わりに std::variant<std::monostate> を使ってください)。

variant の選択肢に同じ型を2つ以上指定したり、同じ型の cv 修飾が異なるバージョンを指定したりできます。

集成体初期化に関する union の動作との一貫性のため、デフォルト構築された variant はその最初の選択肢の値を保持します。 ただしその選択肢がデフォルト構築可能でない場合は除きます (その場合、 variant もデフォルト構築可能でなくなります)。 ヘルパークラス std::monostate はそのような variant をデフォルト構築可能にするために使うことができます。

テンプレート引数

Types

-

この variant に格納するかもしれない型。 すべての型は非配列なオブジェクト型 (またはその cv 修飾された型) でなければなりません。

メンバ関数

コンストラクタ	variant オブジェクトを構築します (パブリックメンバ関数)
デストラクタ	格納されている値と共に variant を破棄します (パブリックメンバ関数)
operator=	variant を代入します (パブリックメンバ関数)
観察
index	variant が保持している選択肢の0から始まるインデックスを返します (パブリックメンバ関数)
valueless_by_exception	variant が無効な状態かどうか調べます (パブリックメンバ関数)
変更
emplace	variant 内の値をその場で構築します (パブリックメンバ関数)
swap	別の variant と交換します (パブリックメンバ関数)

非メンバ関数

visit (C++17)	1個以上の variant が保持している引数を渡して指定された関数オブジェクトを呼びます (関数テンプレート)
holds_alternative (C++17)	variant が現在指定された型を保持しているかどうか調べます (関数テンプレート)
std::get(std::variant) (C++17)	指定されたインデックスまたは型 (一意な場合) の値を variant から読み込みます。 エラーの場合は例外を投げます (関数テンプレート)
get_if (C++17)	指定されたインデックスまたは型 (一意な場合) の値へのポインタを取得します。 エラーの場合はヌルを返します (関数テンプレート)
operator==operator!=operator<operator<=operator>operator>=operator<=> (C++17)(C++17)(C++17)(C++17)(C++17)(C++17)(C++20)	格納されている値として variant オブジェクトを比較します (関数テンプレート)
std::swap(std::variant) (C++17)	std::swap アルゴリズムの特殊化 (関数)

ヘルパークラス

monostate (C++17)	デフォルト構築可能でない型の variant で最初の選択肢として使用するためのプレースホルダー型 (クラス)
bad_variant_access (C++17)	variant の値への無効なアクセスで投げられる例外 (クラス)
variant_sizevariant_size_v (C++17)	variant の選択肢のリストのサイズをコンパイル時に取得します (クラステンプレート) (変数テンプレート)
variant_alternativevariant_alternative_t (C++17)	インデックスで指定された選択肢の型をコンパイル時に取得します (クラステンプレート) (エイリアステンプレート)
std::hash<std::variant> (C++17)	std::hash アルゴリズムの特殊化 (クラステンプレートの特殊化)

ヘルパーオブジェクト

variant_npos (C++17)

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

欠陥報告

以下の動作変更欠陥報告は以前に発行された C++ 標準に遡って適用されました。

DR	適用先	発行時の動作	正しい動作
LWG 2901	C++17	std::uses_allocator の特殊化が提供されていますが、 variant はアロケータを適切にサポートできません	仕様は削除されました

例

Run this code

#include <variant>
#include <string>
#include <cassert>

int main()
{
    std::variant<int, float> v, w;
    v = 12; // v は int を格納します。
    int i = std::get<int>(v);
    w = std::get<int>(v);
    w = std::get<0>(v); // 前行と同じ効果。
    w = v; // 前行と同じ効果。

//  std::get<double>(v); // エラー、 <int, float> の中に double はありません。
//  std::get<3>(v);      // エラー、有効なインデックスは 0 と 1 だけです。

    try {
      std::get<float>(w); // w は float ではなく int なので、例外を投げます。
    }
    catch (const std::bad_variant_access&) {}

    using namespace std::literals;

    std::variant<std::string> x("abc"); // 曖昧でなければ、
                                        // 変換コンストラクタが働きます。
    x = "def"; // 曖昧でなければ、変換代入も働きます。

    std::variant<std::string, void const*> y("abc"); // char const * が渡されると、
                                                     // void const * にキャストされます。
    assert(std::holds_alternative<void const*>(y)); // 成功します。
    y = "xyz"s;
    assert(std::holds_alternative<std::string>(y)); // 成功します。
}

関連項目

in_place in_place_type in_place_index in_place_t in_place_type_t in_place_index_t (C++17)	その場構築のタグ (クラステンプレート)
optional (C++17)	値を保持するかもしれないし保持しないかもしれないラッパー (クラステンプレート)
any (C++17)	CopyConstructible な型の任意のインスタンスを保持するオブジェクト (クラス)