namespace std {
  template <class T, class U>
  constexpr bool operator==(const optional<T>& x, const optional<U>& y); // (1) C++17

  template <class T>
  constexpr bool operator==(const optional<T>& x, nullopt_t) noexcept;   // (2) C++17

  template <class T, class U>
  constexpr bool operator==(const optional<T>& x, const U& y);           // (3) C++17

  template <class T, class U>
  constexpr bool operator==(const T& x, const optional<U>& y);           // (4) C++17

  // (2) により、以下のオーバーロードが使用可能になる (C++20)
  template <class T>
  constexpr bool operator==(nullopt_t, const optional<T>& y) noexcept;   // (5) C++17
}

概要

optionalオブジェクトの等値比較を行う。

テンプレートパラメータ制約

• (1), (3), (4) : 型Tが==で比較可能であり、その戻り値型がboolに変換可能であること
• (3), (4) : 比較する相手の型がoptionalの特殊化でないこと

戻り値

• (1) : xとyがどちらも有効値を持っていれば、有効値同士を等値比較した結果を返す。xとyがどちらも有効値を持っていなければtrueを返す。xとyのうち、どちらかが有効値を持ち、どちらかが持たない場合はfalseを返す
• (2) : xが有効値を持っていなければtrue、そうでなければfalseを返す
• (3) : xが有効値を持っていれば、yと等値比較した結果を返す。そうでなければfalseを返す
• (4) : yが有効値を持っていれば、xと等値比較した結果を返す。そうでなければfalseを返す
• (5) : yが有効値を持っていなければtrue、そうでなければfalseを返す

備考

• (2) : この演算子により、以下の演算子が使用可能になる (C++20)：
  • bool operator==(const nullopt_t&, const optional<T>&) noexcept;
  • bool operator!=(const optional<T>&, const nullopt_t&) noexcept;
  • bool operator!=(const nullopt_t&, const optional<T>&) noexcept;

例

#include <cassert>
#include <optional>

int main()
{
  // optionalオブジェクト同士の比較
  {
    std::optional<int> a = 3;
    std::optional<int> b = 1;
    std::optional<int> c = 3;
    std::optional<int> none;

    assert(a == c);
    assert(!(a == b));
    assert(!(a == none));
    assert(!(none == a));
  }

  // optionalオブジェクトとnulloptの比較
  {
    std::optional<int> p = 3;
    std::optional<int> none;

    assert(!(p == std::nullopt));
    assert(none == std::nullopt);

    assert(!(std::nullopt == p));
    assert(std::nullopt == none);
  }

  // optionalオブジェクトと有効値の比較
  {
    std::optional<int> p = 3;
    std::optional<int> none;

    assert(p == 3);
    assert(3 == p);

    assert(!(none == 3));
    assert(!(3 == none));
  }
}

出力

バージョン

言語

• C++17

処理系

• Clang: 4.0.1 ✅
• GCC: 7.2 ✅
• Visual C++: ??

参照

• LWG Issue 2934. optional<const T> doesn't compare with T
• P1614R2 The Mothership has Landed
  • C++20での三方比較演算子の追加と、関連する演算子の自動導出
• P2944R3 Comparisons for reference_wrapper
  • C++26でテンプレートパラメータ制約が整理された
• LWG Issue 4072. std::optional comparisons: constrain harder
  • C++26で、optionalと値の比較演算子の制約に、相手の型がoptionalの特殊化でないことが追加された（optional同士の比較がこのオーバーロードに解決されるのを防ぐ）
• LWG Issue 4370. Comparison of optional<T> to T may be ill-formed
  • C++26で、効果が三項演算子形式（x.has_value() ? *x == v : false）からif文形式へ変更された。比較結果がbool以外の型を返す場合に三項演算子で共通型が得られず不適格となる問題を防ぐもの（cpprefjpの戻り値の記述はもともとこの意味を表している）