std::unordered_map

 

C++

言語

標準ライブラリヘッダ

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

名前付き要件

言語サポートライブラリ

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

診断ライブラリ

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

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

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

アルゴリズムライブラリ

数値演算ライブラリ

入出力ライブラリ

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

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

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

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

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

技術仕様書

 

コンテナライブラリ

array (C++11)

vector

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

span (C++20)

 

std::unordered_map

メンバ関数

unordered_map::unordered_map

unordered_map::~unordered_map

unordered_map::operator=

unordered_map::get_allocator

イテレータ

unordered_map::beginunordered_map::cbegin

unordered_map::endunordered_map::cend

容量

unordered_map::empty

unordered_map::size

unordered_map::max_size

変更

unordered_map::clear

unordered_map::insert

unordered_map::insert_or_assign (C++17)

unordered_map::emplace

unordered_map::emplace_hint

unordered_map::try_emplace (C++17)

unordered_map::erase

unordered_map::swap

unordered_map::extract (C++17)

unordered_map::merge (C++17)

検索

unordered_map::at

unordered_map::operator[]

unordered_map::count

unordered_map::find

unordered_map::contains (C++20)

unordered_map::equal_range

バケットインタフェース

unordered_map::begin(size_type)unordered_map::cbegin(size_type)

unordered_map::end(size_type)unordered_map::cend(size_type)

unordered_map::bucket_count

unordered_map::max_bucket_count

unordered_map::bucket_size

unordered_map::bucket

ハッシュポリシー

unordered_map::load_factor

unordered_map::max_load_factor

unordered_map::rehash

unordered_map::reserve

観察

unordered_map::hash_function

unordered_map::key_eq

推定ガイド(C++17)

 

ヘッダ <unordered_map> で定義
template<     class Key,     class T,     class Hash = std::hash<Key>,     class KeyEqual = std::equal_to<Key>,     class Allocator = std::allocator< std::pair<const Key, T> > > class unordered_map;	(1)	(C++11以上)
namespace pmr {     template <class Key,               class T,               class Hash = std::hash<Key>,               class Pred = std::equal_to<Key>>     using unordered_map = std::unordered_map<Key, T, Hash, Pred,                               std::pmr::polymorphic_allocator<std::pair<const Key,T>>>; }	(2)	(C++17以上)

unordered map はキーが一意なキー値ペアを格納する連想コンテナです。 要素の検索、挿入、削除は平均定数時間の計算量です。

内部的には、要素は特定の順序にソートされず、複数のバケットにまとめられます。 要素がどのバケットに配置されるかはもっぱらその値のハッシュに依存します。 これにより、いったんハッシュが計算されればその要素が配置される正確なバケットを参照できるため、個々の要素への高速なアクセスが可能になります。

std::unordered_map は Container, AllocatorAwareContainer, UnorderedAssociativeContainer の要件を満たします。

イテレータの無効化

操作	無効化
すべての読み込み操作および swap, std::swap	決して無効化されません
clear, rehash, reserve, operator=	常に無効化されます
insert, emplace, emplace_hint, operator[]	再ハッシュが発生した場合のみ無効化されます
erase	削除された要素のみ無効化されます

ノート

• swap 関数はコンテナ内部のいかなるイテレータも無効化しませんが、 swap 範囲の終端をマークするイテレータは無効化されます。

• コンテナに格納されているキーまたはデータへの参照およびポインタは、対応するイテレータが無効化されたとしても、その要素が削除された場合にしか無効化されません。

メンバ型

メンバ型	定義
key_type	Key
mapped_type	T
value_type	std::pair<const Key, T>
size_type	符号なし整数型 (通常 std::size_t)
difference_type	符号付き整数型 (通常 std::ptrdiff_t)
hasher	Hash
key_equal	KeyEqual (C++20未満) 定義されていて型を表す場合は Hash::transparent_key_equal、そうでなければ KeyEqual (C++20以上)
allocator_type	Allocator
reference	value_type&
const_reference	const value_type&
pointer	std::allocator_traits<Allocator>::pointer
const_pointer	std::allocator_traits<Allocator>::const_pointer
iterator	LegacyForwardIterator
const_iterator	const LegacyForwardIterator
local_iterator	カテゴリおよび value, difference, pointer, reference の各型が iterator と同じイテレータ型。 このイテレータはバケット内をイテレートするために使用することができますが、別のバケットには移動できません
const_local_iterator	カテゴリおよび value, difference, pointer, reference の各型が const_iterator と同じイテレータ型。 このイテレータはバケット内をイテレートするために使用することができますが、別のバケットには移動できません
node_type (C++17以上)	コンテナノードを表すノードハンドルの特殊化
insert_return_type (C++17以上)	node_type を挿入した結果を表す型。 テンプレート引数 iterator および node_type でインスタンス化された template <class Iter, class NodeType> struct /*unspecified*/ { Iter position; bool inserted; NodeType node; }; の特殊化

メンバ関数

コンストラクタ	unordered_map を構築します (パブリックメンバ関数)
デストラクタ	unordered_map を破棄します (パブリックメンバ関数)
operator=	コンテナに値を代入します (パブリックメンバ関数)
get_allocator	関連付けられているアロケータを返します (パブリックメンバ関数)
イテレータ
begin cbegin	先頭を指すイテレータを返します (パブリックメンバ関数)
end cend	終端を指すイテレータを返します (パブリックメンバ関数)
容量
empty	コンテナが空かどうか調べます (パブリックメンバ関数)
size	要素数を返します (パブリックメンバ関数)
max_size	可能な最大の要素数を返します (パブリックメンバ関数)
変更
clear	すべての要素を削除します (パブリックメンバ関数)
insert	要素またはノード (C++17以上)を挿入します (パブリックメンバ関数)
insert_or_assign (C++17)	要素を挿入します。 キーがすでに存在している場合は現在の要素に代入します (パブリックメンバ関数)
emplace	要素をその場で構築します (パブリックメンバ関数)
emplace_hint	ヒントを使用して要素をその場で構築します (パブリックメンバ関数)
try_emplace (C++17)	キーが存在しなければその場で挿入します。 キーが存在している場合は何もしません (パブリックメンバ関数)
erase	要素を削除します (パブリックメンバ関数)
swap	内容を入れ替えます (パブリックメンバ関数)
extract (C++17)	コンテナからノードを抽出します (パブリックメンバ関数)
merge (C++17)	他のコンテナからノードを接合します (パブリックメンバ関数)
検索
at	境界チェック付きで指定された要素にアクセスします (パブリックメンバ関数)
operator[]	指定された要素にアクセスまたは挿入します (パブリックメンバ関数)
count	指定されたキーと一致する要素の数を返します (パブリックメンバ関数)
find	指定されたキーを持つ要素を探します (パブリックメンバ関数)
contains (C++20)	コンテナが指定されたキーを持つ要素を格納しているかどうか調べます (パブリックメンバ関数)
equal_range	指定されたキーに一致する要素の範囲を返します (パブリックメンバ関数)
バケットインタフェース
begin(size_type) cbegin(size_type)	指定されたバケットの先頭を指すイテレータを返します (パブリックメンバ関数)
end(size_type) cend(size_type)	指定されたバケットの終端を指すイテレータを返します (パブリックメンバ関数)
bucket_count	バケットの数を返します (パブリックメンバ関数)
max_bucket_count	バケットの最大数を返します (パブリックメンバ関数)
bucket_size	特定のバケットの要素数を返します (パブリックメンバ関数)
bucket	指定されたキーのためのバケットを返します (パブリックメンバ関数)
ハッシュポリシー
load_factor	バケットあたりの平均要素数を返します (パブリックメンバ関数)
max_load_factor	バケットあたりの平均要素数の最大値を管理します (パブリックメンバ関数)
rehash	少なくとも指定された数のバケットを予約します。 これによりハッシュテーブルが再生成されます。 (パブリックメンバ関数)
reserve	少なくとも指定された数の要素のための空間を予約します。 これによりハッシュテーブルが再生成されます。 (パブリックメンバ関数)
観察
hash_function	キーをハッシュするために使用される関数を返します (パブリックメンバ関数)
key_eq	キーが等しいかどうかを比較するために使用される関数を返します (パブリックメンバ関数)

非メンバ関数

operator==operator!=	unordered_map 内の値を比較します (関数テンプレート)
std::swap(std::unordered_map) (C++11)	std::swap アルゴリズムの特殊化 (関数テンプレート)
erase_if(std::unordered_map) (C++20)	特定の基準を満たすすべての要素を削除します (関数テンプレート)

例

Run this code

#include <iostream>
#include <string>
#include <unordered_map>
 
int main()
{
    // Create an unordered_map of three strings (that map to strings)
    std::unordered_map<std::string, std::string> u = {
        {"RED","#FF0000"},
        {"GREEN","#00FF00"},
        {"BLUE","#0000FF"}
    };
 
    // Iterate and print keys and values of unordered_map
    for( const auto& n : u ) {
        std::cout << "Key:[" << n.first << "] Value:[" << n.second << "]\n";
    }
 
    // Add two new entries to the unordered_map
    u["BLACK"] = "#000000";
    u["WHITE"] = "#FFFFFF";
 
    // Output values by key
    std::cout << "The HEX of color RED is:[" << u["RED"] << "]\n";
    std::cout << "The HEX of color BLACK is:[" << u["BLACK"] << "]\n";
 
    return 0;
}

出力:

Key:[RED] Value:[#FF0000]
Key:[BLUE] Value:[#0000FF]
Key:[GREEN] Value:[#00FF00]
The HEX of color RED is:[#FF0000]
The HEX of color BLACK is:[#000000]