operator==, !=, <, <=, >, >=, <=>(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 > constexpr bool operator==( const std::variant<Types...>& lhs,                            const std::variant<Types...>& rhs );	(1)	(C++17以降)
template< class... Types > constexpr bool operator!=( const std::variant<Types...>& lhs,                            const std::variant<Types...>& rhs );	(2)	(C++17以降)
template< class... Types > constexpr bool operator<( const std::variant<Types...>& lhs,                           const std::variant<Types...>& rhs );	(3)	(C++17以降)
template< class... Types > constexpr bool operator>( const std::variant<Types...>& lhs,                           const std::variant<Types...>& rhs );	(4)	(C++17以降)
template< class... Types > constexpr bool operator<=( const std::variant<Types...>& lhs,                            const std::variant<Types...>& rhs );	(5)	(C++17以降)
template< class... Types > constexpr bool operator>=( const std::variant<Types...>& lhs,                            const std::variant<Types...>& rhs );	(6)	(C++17以降)
template< class... Types > constexpr std::common_comparison_category_t               <std::compare_three_way_result_t<Types>...>     operator<=>( const std::variant<Types...>& lhs,                  const std::variant<Types...>& rhs );	(7)	(C++20以降)
ヘルパー関数テンプレート
template< std::size_t I, class... Types > constexpr const std::variant_alternative_t<I, std::variant<Types...>>&     GET( const variant<Types...>& v );	(8)	(説明用*)

std::variant オブジェクトに対して比較演算を実行します。

1-7) 2つの std::variant オブジェクト lhs と rhs を比較します。含まれる値は、lhs と rhs の両方が同じインデックスに対応する値を含んでいる場合にのみ比較されます (T の対応する演算子を使用)。そうでない場合、

• lhs は、lhs と rhs の両方が値を含んでいない場合に限り、rhs と等しいと見なされます。
• lhs は、rhs が値を持ち lhs が持たない場合、または lhs.index() が rhs.index() より小さい場合に限り、rhs より小さいと見なされます。

1-6) @ を対応する比較演算子とします。これらの各関数について、

ある I の値について、対応する式 GET <I>(lhs) @ GET <I>(rhs) が不正な形式であるか、その結果が bool に変換できない場合、プログラムは不正な形式です。	(C++26まで)
このオーバーロードは、すべての I の値について、対応する式 GET <I>(lhs) @ GET <I>(rhs) が正しい形式であり、その結果が bool に変換できる場合にのみ、オーバーロード解決に参加します。	(C++26以降)

8) 説明専用関数テンプレート GET は、std::bad_variant_access がスローされないことを除いて、std::get(std::variant) と同様に動作します。

I < sizeof...(Types) が false の場合、プログラムは不正な形式です。

I == v.index() が false の場合、動作は未定義です。

パラメータ

lhs,rhs

-

比較するバリアント

戻り値

演算子	両方のオペランドが値を含む (I を lhs.index() とし、J を rhs.index() とします)		lhs または rhs が値を持たない (lhs_empty を lhs.valueless_by_exception() とし、rhs_empty を rhs.valueless_by_exception() とします)
	I と J は等しい	I と J は等しくない
==	GET <I>(lhs) == GET <I>(rhs)	false	lhs_empty && rhs_empty
!=	GET <I>(lhs) != GET <I>(rhs)	true	lhs_empty != rhs_empty
<	GET <I>(lhs) < GET <I>(rhs)	lhs.index() < rhs.index()	lhs_empty && !rhs_empty
>	GET <I>(lhs) > GET <I>(rhs)	lhs.index() > rhs.index()	!lhs_empty && rhs_empty
<=	GET <I>(lhs) <= GET <I>(rhs)	lhs.index() < rhs.index()	lhs_empty
>=	GET <I>(lhs) >= GET <I>(rhs)	lhs.index() > rhs.index()	rhs_empty
<=>	GET <I>(lhs) <=> GET <I>(rhs)	lhs.index() <=> rhs.index()	下記参照

operator<=> について

• lhs のみが値を持たない場合、std::strong_ordering::less を返します。
• rhs のみが値を持たない場合、std::strong_ordering::greater を返します。
• lhs と rhs の両方が値を持たない場合、std::strong_ordering::equal を返します。

ノート

機能テストマクロ	値	規格	機能
__cpp_lib_constrained_equality	202403L	(C++26)	std::variant の制約付き比較演算子

例

このコードを実行

#include <iostream>
#include <string>
#include <variant>
 
int main()
{
    std::cout << std::boolalpha;
    std::string cmp;
    bool result;
 
    auto print2 = [&cmp, &result](const auto& lhs, const auto& rhs)
    {
        std::cout << lhs << ' ' << cmp << ' ' << rhs << " : " << result << '\n';
    };
 
    std::variant<int, std::string> v1, v2;
 
    std::cout << "operator==\n";
    {
        cmp = "==";
 
        // by default v1 = 0, v2 = 0;
        result = v1 == v2; // true
        std::visit(print2, v1, v2);
 
        v1 = v2 = 1;
        result = v1 == v2; // true
        std::visit(print2, v1, v2);
 
        v2 = 2;
        result = v1 == v2; // false
        std::visit(print2, v1, v2);
 
        v1 = "A";
        result = v1 == v2; // false: v1.index == 1, v2.index == 0
        std::visit(print2, v1, v2);
 
        v2 = "B";
        result = v1 == v2; // false
        std::visit(print2, v1, v2);
 
        v2 = "A";
        result = v1 == v2; // true
        std::visit(print2, v1, v2);
    }
 
    std::cout << "operator<\n";
    {
        cmp = "<";
 
        v1 = v2 = 1;
        result = v1 < v2; // false
        std::visit(print2, v1, v2);
 
        v2 = 2;
        result = v1 < v2; // true
        std::visit(print2, v1, v2);
 
        v1 = 3;
        result = v1 < v2; // false
        std::visit(print2, v1, v2);
 
        v1 = "A"; v2 = 1;
        result = v1 < v2; // false: v1.index == 1, v2.index == 0
        std::visit(print2, v1, v2);
 
        v1 = 1; v2 = "A";
        result = v1 < v2; // true: v1.index == 0, v2.index == 1
        std::visit(print2, v1, v2);
 
        v1 = v2 = "A";
        result = v1 < v2; // false
        std::visit(print2, v1, v2);
 
        v2 = "B";
        result = v1 < v2; // true
        std::visit(print2, v1, v2);
 
        v1 = "C";
        result = v1 < v2; // false
        std::visit(print2, v1, v2);
    }
 
    {
        std::variant<int, std::string> v1;
        std::variant<std::string, int> v2;
    //  v1 == v2; // Compilation error: no known conversion
    }
 
    // TODO: C++20 three-way comparison operator <=> for variants
}

出力

operator==
0 == 0 : true
1 == 1 : true
1 == 2 : false
A == 2 : false
A == B : false
A == A : true
operator<
1 < 1 : false
1 < 2 : true
3 < 2 : false
A < 1 : false
1 < A : true
A < A : false
A < B : true
C < B : false

関連項目

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

optional オブジェクトを比較する (function template)