operator==,!=,<,<=,>,>=,<=>(std::map)

 

C++

コンパイラサポート

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

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

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

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

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

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

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

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

コンテナライブラリ

シーケンス

array (C++11)

vector

vector<bool>

inplace_vector (C++26)

hive (C++26)

deque

forward_list (C++11)

list

連想

set

multiset

map

multimap

非順序連想

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

アダプタ

stack

queue

priority_queue

flat_set (C++23)

flat_multiset (C++23)

flat_map (C++23)

flat_multimap (C++23)

表示

span (C++20)

mdspan (C++23)

表

イテレータの無効化

メンバ関数テーブル

非メンバ関数テーブル

 

std::map

メンバ関数

map::map map::~map               map::operator= map::get_allocator

要素アクセス map::at map::operator[] イテレータ map::beginmap::cbegin (C++11) map::endmap::cend (C++11) map::rbeginmap::crbegin (C++11)      map::rendmap::crend (C++11) 容量 map::size map::max_size map::empty 監視 map::key_comp map::value_comp 変更 map::clear map::insert map::erase map::swap map::extract (C++17) map::merge (C++17) map::insert_range (C++23) map::insert_or_assign (C++17) map::emplace (C++11) map::emplace_hint (C++11) map::try_emplace (C++17) 検索 map::count map::find map::contains (C++20) map::equal_range map::lower_bound map::upper_bound

非メンバ関数

operator==operator<=> (C++20) std::swap(std::map) erase_if(std::map) (C++20)   operator!=operator<operator>operator<=operator>= (C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20まで)

推論補助 (C++17)

 

ヘッダ <map> で定義
template< class Key, class T, class Compare, class Alloc > bool operator==( const std::map<Key, T, Compare, Alloc>& lhs,                  const std::map<Key, T, Compare, Alloc>& rhs );	(1)
template< class Key, class T, class Compare, class Alloc > bool operator!=( const std::map<Key, T, Compare, Alloc>& lhs,                  const std::map<Key, T, Compare, Alloc>& rhs );	(2)	(C++20まで)
template< class Key, class T, class Compare, class Alloc > bool operator<( const std::map<Key, T, Compare, Alloc>& lhs,                 const std::map<Key, T, Compare, Alloc>& rhs );	(3)	(C++20まで)
template< class Key, class T, class Compare, class Alloc > bool operator<=( const std::map<Key, T, Compare, Alloc>& lhs,                  const std::map<Key, T, Compare, Alloc>& rhs );	(4)	(C++20まで)
template< class Key, class T, class Compare, class Alloc > bool operator>( const std::map<Key, T, Compare, Alloc>& lhs,                 const std::map<Key, T, Compare, Alloc>& rhs );	(5)	(C++20まで)
template< class Key, class T, class Compare, class Alloc > bool operator>=( const std::map<Key, T, Compare, Alloc>& lhs,                  const std::map<Key, T, Compare, Alloc>& rhs );	(6)	(C++20まで)
template< class Key, class T, class Compare, class Alloc > synth-three-way-result<T>     operator<=>( const std::map<Key, T, Compare, Alloc>& lhs,                  const std::map<Key, T, Compare, Alloc>& rhs );	(7)	(C++20以降)

2つのmapの内容を比較します。

1,2) lhsとrhsの内容が等しいか、すなわち、要素数が同じで、lhsの各要素がrhsの同じ位置の要素と等しいかを確認します。

3-6) lhs と rhs の内容を辞書順で比較します。比較は std::lexicographical_compare と同等の関数によって行われます。この比較では、map の順序付け Compare は無視されます。

7) lhs と rhs の内容を辞書順で比較します。比較は、std::lexicographical_compare_three_way(lhs.begin(), lhs.end(),
                                       rhs.begin(), rhs.end(), synth-three-way) を呼び出すのと同等に行われます。この比較では、map の順序付け Compare は無視されます。

戻り値の型はsynth-three-wayの戻り値の型（つまり、synth-three-way-result <T>）です。

以下の条件のいずれも満たされない場合、動作は未定義です

• Tはthree_way_comparableのモデルです。
• 型（おそらくconst修飾された）Tの値に対して<が定義されており、<は全順序関係です。

<, <=, >, >=, != 演算子は、それぞれ operator<=> と operator== から合成されます。

(C++20以降)

パラメータ

lhs, rhs	-	比較するmap
- T, Key は、オーバーロード (1,2) を使用するために EqualityComparable の要件を満たす必要があります。
- オーバーロード (3-6) を使用するために、Key は LessThanComparable の要件を満たす必要があります。順序関係は全順序を確立する必要があります。

戻り値

1) map の内容が等しい場合は true、そうでない場合は false。

2) map の内容が等しくない場合は true、そうでない場合は false。

3) lhsの内容がrhsの内容よりも辞書的に小さい場合はtrue、そうでない場合はfalse。

4) lhsの内容がrhsの内容よりも辞書的に小さいか等しい場合はtrue、そうでない場合はfalse。

5) lhsの内容がrhsの内容よりも辞書的に大きい場合はtrue、そうでない場合はfalse。

6) lhsの内容がrhsの内容よりも辞書的に大きいか等しい場合はtrue、そうでない場合はfalse。

7) lhsとrhsに非等価な要素の最初のペアが存在する場合はその相対順序、それ以外の場合はlhs.size() <=> rhs.size()。

計算量

1,2) lhs と rhs のサイズが異なる場合は定数時間、それ以外の場合は map のサイズに線形時間。

3-7) map のサイズに線形時間。

備考

関係演算子は、要素型のoperator<を介して定義されます。	(C++20まで)
関係演算子はsynth-three-wayを介して定義されます。synth-three-wayは、可能であればoperator<=>を使用し、そうでなければoperator<を使用します。 特に、要素自身がoperator<=>を提供しないが、三方比較可能な型に暗黙的に変換できる場合、その変換がoperator<の代わりに使用されます。	(C++20以降)

例

このコードを実行

#include <cassert>
#include <compare>
#include <map>
 
int main()
{
    std::map<int, char> a{{1, 'a'}, {2, 'b'}, {3, 'c'}};
    std::map<int, char> b{{1, 'a'}, {2, 'b'}, {3, 'c'}};
    std::map<int, char> c{{7, 'Z'}, {8, 'Y'}, {9, 'X'}, {10, 'W'}};
 
    assert
    (""
        "Compare equal containers:" &&
        (a != b) == false &&
        (a == b) == true &&
        (a < b) == false &&
        (a <= b) == true &&
        (a > b) == false &&
        (a >= b) == true &&
        (a <=> b) != std::weak_ordering::less &&
        (a <=> b) != std::weak_ordering::greater &&
        (a <=> b) == std::weak_ordering::equivalent &&
        (a <=> b) >= 0 &&
        (a <=> b) <= 0 &&
        (a <=> b) == 0 &&
 
        "Compare non equal containers:" &&
        (a != c) == true &&
        (a == c) == false &&
        (a < c) == true &&
        (a <= c) == true &&
        (a > c) == false &&
        (a >= c) == false &&
        (a <=> c) == std::weak_ordering::less &&
        (a <=> c) != std::weak_ordering::equivalent &&
        (a <=> c) != std::weak_ordering::greater &&
        (a <=> c) < 0 &&
        (a <=> c) != 0 &&
        (a <=> c) <= 0 &&
    "");
}

欠陥報告

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

DR	適用対象	公開された動作	正しい動作
LWG 3431	C++20	operator<=>はTを必要としませんでした three_way_comparableのモデルとするために	要求するようになった