std::unordered_set

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

容器庫

序列

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::unordered_set

成員型別
成員函式
unordered_set::unordered_set unordered_set::~unordered_set unordered_set::operator= unordered_set::get_allocator 迭代器 unordered_set::beginunordered_set::cbegin unordered_set::endunordered_set::cend 容量 unordered_set::size unordered_set::max_size unordered_set::empty 修改器 unordered_set::clear unordered_set::erase unordered_set::swap unordered_set::extract (C++17) unordered_set::merge (C++17) unordered_set::insert unordered_set::insert_range (C++23)   unordered_set::emplace unordered_set::emplace_hint	查詢 unordered_set::count unordered_set::find unordered_set::contains (C++20) unordered_set::equal_range 桶介面 unordered_set::begin(size_type)unordered_set::cbegin(size_type) unordered_set::end(size_type)unordered_set::cend(size_type) unordered_set::bucket_count unordered_set::max_bucket_count unordered_set::bucket_size unordered_set::bucket 雜湊策略 unordered_set::load_factor unordered_set::max_load_factor unordered_set::rehash unordered_set::reserve 觀察器 unordered_set::hash_function unordered_set::key_eq
非成員函式
operator==operator!= (C++20之前)	std::swap(std::unordered_set) erase_if(std::unordered_set) (C++20)
推導指南 (C++17起)

 

定義於標頭檔案 <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	僅被擦除的元素

注意

• 交換函式不會使容器內的任何迭代器失效，但它們會使標記交換區域末尾的迭代器失效。

• 指向容器中儲存資料的引用和指標僅在擦除該元素時才失效，即使相應的迭代器失效也是如此。

• 容器移動賦值後，除非由於不相容的分配器強制進行元素級移動賦值，否則指向被移動容器的引用、指標和迭代器（除了尾後迭代器）保持有效，但它們現在指向 *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	常數 LegacyForwardIterator 和 ConstexprIterator(C++26起) 到 value_type
const_iterator	LegacyForwardIterator 和 ConstexprIterator(C++26起) 到 const value_type
local_iterator	一種迭代器型別，其類別、值、差值、指標和 引用型別與 iterator 相同。此迭代器 可用於迭代單個桶，但不能跨桶迭代
const_local_iterator	一種迭代器型別，其類別、值、差值、指標和 引用型別與 const_iterator 相同。此迭代器 可用於迭代單個桶，但不能跨桶迭代
node_type (C++17 起)	node handle 的特化，表示一個容器節點
insert_return_type (C++17起)	描述插入 node_type 結果的型別，一個特化 template<class Iter, class NodeType> struct /*unspecified*/ {     Iter     position;     bool     inserted;     NodeType node; }; 以模板引數 iterator 和 node_type 例項化。

成員函式

(建構函式)	構造 unordered_set (公有成員函式)
(解構函式)	析構 unordered_set (公有成員函式)
operator=	將值賦給容器 (公有成員函式)
get_allocator	返回關聯的分配器 (公有成員函式)
迭代器
begincbegin	返回指向起始的迭代器 (公有成員函式)
endcend	返回指向末尾的迭代器 (公有成員函式)
容量
empty	檢查容器是否為空 (公有成員函式)
size	返回元素數量 (公有成員函式)
max_size	返回元素的最大可能數量 (公有成員函式)
修改器
clear	清除內容 (公有成員函式)
insert	插入元素 或節點(C++17 起) (公有成員函式)
insert_range (C++23)	插入元素範圍 (公有成員函式)
emplace	就地構造元素 (公有成員函式)
emplace_hint	使用提示就地構造元素 (公有成員函式)
erase	擦除元素 (公有成員函式)
swap	交換內容 (公有成員函式)
extract (C++17)	從容器中提取節點 (公有成員函式)
merge (C++17)	從另一個容器拼接節點 (公有成員函式)
查詢
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!= (C++11起)(C++11起)(C++20中移除)	比較 unordered_set 中的值 (函式模板)
std::swap(std::unordered_set) (C++11)	特化 std::swap 演算法 (函式模板)
erase_if(std::unordered_set) (C++20)	擦除所有滿足特定標準的元素 (函式模板)

推導指引

(C++17 起)

注意

成員型別 iterator 和 const_iterator 可以是相同型別的別名。這意味著使用這兩種型別作為引數型別定義一對函式過載可能違反 One Definition Rule。由於 iterator 可以轉換為 const_iterator，因此可以使用單個以 const_iterator 作為引數型別的函式。

特性測試宏	值	標準	特性
__cpp_lib_containers_ranges	202202L	(C++23)	容器的範圍構造和插入
__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);
}

可能的輸出

8 1 7 2
5 8 1 7 2
8 1 7 2
8 1 2

缺陷報告

下列更改行為的缺陷報告追溯地應用於以前出版的 C++ 標準。

缺陷報告	應用於	釋出時的行為	正確的行為
LWG 2050	C++11	reference、const_reference、pointer 和 const_pointer 的定義基於 allocator_type	基於 value_type 和 std::allocator_traits

另請參閱

unordered_multiset (C++11)	鍵的集合，按鍵雜湊 (類模板)
set	唯一鍵的集合，按鍵排序 (類模板)
flat_set (C++23)	適配容器以提供唯一鍵的集合，按鍵排序 (類模板)