最終更新日時(UTC): 2026年02月17日 14時22分33秒
Akira Takahashi が更新

履歴 編集

function
<unordered_map>

# std::unordered_map::key_eq(C++11)

    key_equal key_eq() const;           // (1) C++11
    constexpr key_equal key_eq() const; // (1) C++26

## 概要

コンテナのキー比較用関数オブジェクトを返す

## 戻り値

コンテナのキー比較用関数オブジェクト。

このメンバ関数で返されるキー比較用関数オブジェクトは、コンストラクタ、あるいは、直近の代入（コピー、あるいはムーブ）、交換でコンテナに保存されたオブジェクトのコピーである。

## 計算量

定数

## 備考

戻り値の型である、キー比較用関数オブジェクトの型 `key_equal` は、`unordered_map` のメンバ型で、四番目のテンプレートパラメータ `Pred` を別名定義したものである。

キー比較用関数オブジェクトは、名前の通りキーを比較するためのオブジェクトで、与えられた二つのキーが等しいときには `true`、等しくないときには `false` を返すメンバ関数 `bool operator()(key_type, key_type)`を持つ必要がある。

テンプレートパラメータを省略した場合、`key_equal` はデフォルト値 `std::equal_to<key_type>` となる。

## 例

    #include <iostream>
    #include <string>
    #include <unordered_map>

    int main()
    {
      std::cout << std::boolalpha;

      std::unordered_map<std::string, int> um = {
        {"1st", 1},
        {"2nd", 2},
        {"3rd", 3}
      };

      decltype(um)::key_equal eq{ um.key_eq() };

      std::cout << "eq(\"1st\", \"2nd\") = " << eq("1st", "2nd") << std::endl;
      std::cout << "eq(\"1st\", \"1st\") = " << eq("1st", "1st") << std::endl;
    }

### 出力

    eq("1st", "2nd") = false
    eq("1st", "1st") = true

## バージョン

### 言語

- C++11

### 処理系

- Clang: 3.1 ✅
- GCC: 4.7.0 ✅
- ICC: ?
- Visual C++: ?

## 関連項目

名前 | 説明
--- | ---
`equal_to` | 等値比較演算関数オブジェクト(class template)
`hash_function` | ハッシュ関数オブジェクトの取得

## 参照

- P3372R3 constexpr containers and adaptors