std::unordered_set

 

C++

編譯器支援

獨立式與託管式

語言

標準函式庫

標準函式庫標頭檔

具名要求

特性測試巨集 (C++20)

語言支援函式庫

概念函式庫 (C++20)

診斷函式庫

記憶體管理函式庫

元編程函式庫 (C++11)

通用公用程式函式庫

容器函式庫

疊代器函式庫

Ranges 函式庫 (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)

適配器 (Adaptors)

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 Bucket 介面 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 雜湊策略 (Hash policy) 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 的唯一物件。搜尋、插入和移除操作具有平均常數時間複雜度。

在內部，元素不會以任何特定順序排序，而是組織成桶（buckets）。元素被放置到哪個桶中完全取決於其值的雜湊值（hash）。這允許對單個元素進行快速存取，因為一旦計算出雜湊值，它就直接指向元素所在的桶。

容器元素不可修改（即使透過非 const 迭代器也不行），因為修改可能會改變元素的雜湊值並導致容器損毀。

std::unordered_set 符合 Container、AllocatorAwareContainer 以及 UnorderedAssociativeContainer 的要求。

std::unordered_set 的所有成員函式均為 constexpr：可以在常數表達式的評估中建立並使用 std::unordered_set 物件。 然而，std::unordered_set 物件通常不能是 constexpr，因為任何動態配置的記憶體必須在同一個常數表達式評估中釋放。

（C++26 起）

迭代器失效

作業 (Operations)	失效情況
所有唯讀操作、swap、std::swap	從不失效
clear、rehash、reserve、operator=	總是失效
insert、emplace、emplace_hint	僅在導致 rehash 時失效
erase	僅被刪除的元素失效

註解

• 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	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 /*未指定*/ {     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	使用提示（hint）原地建構元素 (公開成員函式)
erase	刪除元素 (公開成員函式)
swap	交換內容 (公開成員函式)
extract (C++17)	從容器中提取節點 (公開成員函式)
merge (C++17)	從另一個容器接合（splice）節點 (公開成員函式)
查找
count	回傳符合指定鍵的元素數量 (公開成員函式)
find	尋找具有指定鍵的元素 (公開成員函式)
contains (C++20)	檢查容器是否包含具有指定鍵的元素 (公開成員函式)
equal_range	回傳與特定鍵相匹配的元素範圍 (公開成員函式)
Bucket 介面
begin(size_type)cbegin(size_type)	返回指向指定桶開頭的迭代器 (公開成員函式)
end(size_type)cend(size_type)	返回指向指定桶結尾的迭代器 (公開成員函式)
bucket_count	返回桶的數量 (公開成員函式)
max_bucket_count	返回桶的最大數量 (公開成員函式)
bucket_size	返回特定桶中的元素數量 (公開成員函式)
bucket	返回特定鍵所屬的桶索引 (公開成員函式)
雜湊策略 (Hash policy)
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++ 標準。

DR	應用於	出版時的行為	正確的行為
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)	適配容器以提供按鍵排序的唯一鍵集合 (類別樣板)