std::unordered_set

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

std::unordered_set は、ユニークな Key 型のオブジェクトの集合を格納する連想コンテナである。検索、挿入、削除は平均して定数時間の計算量を持つ。

内部的に、要素は特定の順序でソートされず、バケットに編成される。どのバケットに要素が配置されるかは、その値のハッシュに完全に依存する。これにより、ハッシュが計算されると、それは要素が配置される正確なバケットを指すため、個々の要素への高速なアクセスが可能になる。

コンテナの要素は、たとえ非constなイテレータであっても変更してはならない。なぜなら、変更によって要素のハッシュが変わり、コンテナが破損する可能性があるからである。

std::unordered_set はコンテナ (Container), アロケータ認識コンテナ (AllocatorAwareContainer), 非順序連想コンテナ (UnorderedAssociativeContainer) の要件を満たす。

std::unordered_set のすべてのメンバ関数は constexpr である: 定数式の評価中に std::unordered_set オブジェクトを作成して使用することが可能である。

しかし、std::unordered_set オブジェクトは一般に constexpr にはなれない。なぜなら、動的に確保されたストレージは同じ定数式の評価中に解放されなければならないからである。

(C++26以降)

操作	無効になる条件
すべての読み取り専用操作、swap、std::swap	無効にならない
clear、rehash、reserve、operator=	常に無効になる
insert、emplace、emplace_hint	リハッシュを引き起こした場合のみ無効になる
erase	削除された要素を指すもののみ無効になる

[編集] 注釈

swap 関数はコンテナ内のどのイテレータも無効にしないが、swap 領域の終端を示すイテレータは無効にする。

コンテナに格納されたデータへの参照とポインタは、対応するイテレータが無効になった場合でも、その要素が消去された場合にのみ無効になる。

コンテナのムーブ代入後、互換性のないアロケータによって要素ごとのムーブ代入が強制されない限り、ムーブ元のコンテナへの参照、ポインタ、イテレータ（過去終端イテレータを除く）は有効なままだが、現在は *this の中にある要素を参照する。

[編集] テンプレートパラメータ

[編集] メンバ型

型	定義
`key_type`	`Key`[編集]
`value_type`	`Key`[編集]
`size_type`	符号なし整数型 (通常は std::size_t)[編集]
`difference_type`	符号付き整数型 (通常は std::ptrdiff_t)[編集]
`hasher`	`Hash`[編集]
`key_equal`	`KeyEqual`[編集]
`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`	`value_type` への定数 LegacyForwardIterator および ConstexprIterator(C++26 以降)[編集]
`const_iterator`	const value_type への LegacyForwardIteratorおよび ConstexprIterator(C++26 以降)[編集]
`local_iterator`	カテゴリ、値、差分、ポインタ、および参照型が `iterator` と同じイテレータ型。このイテレータは、単一のバケットを走査するために使用できるが、バケットをまたいで使用することはできない[編集]
`const_local_iterator`	カテゴリ、値、差分、ポインタ、および参照型が `const_iterator` と同じ。このイテレータは、単一のバケットを走査するために使用できるが、バケットをまたいで使用することはできない[編集]
`node_type` (C++17以降)	コンテナのノードを表すノードハンドルの特殊化[編集]
`insert_return_type` (C++17 以降)	`node_type` の挿入結果を記述する型。以下の特殊化である template<class Iter, class NodeType> struct /未規定/ { Iter position; bool inserted; NodeType node; }; テンプレート引数 `iterator` と `node_type` でインスタンス化される。[編集]

[編集] メンバ関数

(コンストラクタ)	`unordered_set` を構築する (公開メンバ関数) [編集]
(デストラクタ)	`unordered_set` を破棄する (公開メンバ関数) [編集]
operator=	コンテナに値を代入する (公開メンバ関数) [編集]
get_allocator	関連付けられたアロケータを返す (公開メンバ関数) [編集]
イテレータ
begincbegin	先頭へのイテレータを返す (public メンバ関数) [編集]
endcend	末尾へのイテレータを返す (public メンバ関数) [編集]
容量
empty	コンテナが空かどうかをチェックする (public メンバ関数) [編集]
size	要素数を返す (public メンバ関数) [編集]
max_size	可能な最大要素数を返す (public メンバ関数) [編集]
変更
clear	内容をクリアする (公開メンバ関数) [編集]
insert	要素またはノード(C++17以降)を挿入する (公開メンバ関数) [編集]
insert_range (C++23)	要素の範囲を挿入する (公開メンバ関数) [編集]
emplace	要素を直接構築する (公開メンバ関数) [編集]
emplace_hint	ヒントを使用して要素を直接構築する (公開メンバ関数) [編集]
erase	要素を削除する (公開メンバ関数) [編集]
swap	内容を交換する (public メンバ関数) [編集]
extract (C++17)	コンテナからノードを抽出する (公開メンバ関数) [編集]
merge (C++17)	他のコンテナからノードを連結する (公開メンバ関数) [編集]
検索
count	特定のキーに一致する要素の数を返す (公開メンバ関数) [編集]
find	特定のキーを持つ要素を検索する (公開メンバ関数) [編集]
contains (C++20)	コンテナが特定のキーを持つ要素を含むか確認する (公開メンバ関数) [編集]
equal_range	特定のキーに一致する要素の範囲を返す (公開メンバ関数) [編集]
バケットインターフェース
begin(size_type)cbegin(size_type)	指定されたバケットの先頭を指すイテレータを返す (public member function) [編集]
end(size_type)cend(size_type)	指定されたバケットの末尾を指すイテレータを返す (public member function) [編集]
bucket_count	バケット数を返す (public member function) [編集]
max_bucket_count	バケットの最大数を返す (public member function) [編集]
bucket_size	特定のバケット内の要素数を返す (public member function) [編集]
bucket	特定のキーに対するバケットを返す (public member function) [編集]
ハッシュポリシー
load_factor	バケットあたりの平均要素数を返す (public member function) [編集]
max_load_factor	バケットあたりの最大平均要素数を管理する (public member function) [編集]
rehash	少なくとも指定された数のバケットを確保し、ハッシュテーブルを再生成する (public member function) [編集]
reserve	少なくとも指定された数の要素のためのスペースを確保し、ハッシュテーブルを再生成する (public member function) [編集]
監視
hash_function	キーのハッシュに使用される関数を返す (public member function) [編集]
key_eq	キーの等価性比較に使用される関数を返す (public member function) [編集]

[編集] 非メンバ関数

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

推論補助

(C++17以降)

[編集] 注釈

メンバ型 iterator と const_iterator は同じ型へのエイリアスかもしれない。これは、これら2つの型をパラメータ型として使用する関数オーバーロードのペアを定義すると、ODR (One Definition Rule) に違反する可能性があることを意味する。iterator は const_iterator に変換可能なので、代わりに const_iterator をパラメータ型として持つ単一の関数が機能する。

機能テストマクロ	値	規格	機能
`__cpp_lib_containers_ranges`	`202202L`	(C++23)	コンテナのRangeコンストラクタとRange挿入
`__cpp_lib_constexpr_containers`	`202502L`	(C++26)	constexpr `std::unordered_set`

[編集] 例

このコードを実行

#include <iostream>
#include <unordered_set>
 
void print(const auto& set)
{
    for (const auto& elem : set)
        std::cout << elem << ' ';
    std::cout << '\n';
}
 
int main()
{
    std::unordered_set<int> mySet{2, 7, 1, 8, 2, 8}; // creates a set of ints
    print(mySet);
 
    mySet.insert(5); // puts an element 5 in the set
    print(mySet);
 
    if (auto iter = mySet.find(5); iter != mySet.end())
        mySet.erase(iter); // removes an element pointed to by iter
    print(mySet);
 
    mySet.erase(7); // removes an element 7
    print(mySet);
}

実行結果の例

[編集] 欠陥報告

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

DR	適用対象	公開された動作	正しい動作
LWG 2050	C++11	`reference`、`const_reference`、`pointer`、および `const_pointer` の定義が `allocator_type` に基づいていた	`value_type` および std::allocator_traits に基づくように変更

[編集] 関連項目

unordered_multiset (C++11)	キーのコレクション、キーによってハッシュ化される (class template) [編集]
set	ユニークなキーのコレクション、キーによってソートされる (class template) [編集]
flat_set (C++23)	ユニークなキーのコレクションを提供するためにコンテナを適応させる、キーによってソートされる (class template) [編集]

コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (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)
表
イテレータの無効化
メンバ関数テーブル
非メンバ関数テーブル

cppreference.com

名前空間

変種

表示

操作

std::unordered_set

目次

[編集] イテレータの無効化

[編集] 注釈

[編集] テンプレートパラメータ

[編集] メンバ型

[編集] メンバ関数

イテレータ

容量

変更

検索

バケットインターフェース

ハッシュポリシー

監視

[編集] 非メンバ関数

推論補助

[編集] 注釈

[編集] 例

[編集] 欠陥報告

[編集] 関連項目

ナビゲーション

ツールボックス