std::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::set

成員函式

set::set set::~set            set::operator= set::get_allocator

迭代器 set::beginset::cbegin (C++11) set::endset::cend (C++11) set::rbeginset::crbegin (C++11)   set::rendset::crend (C++11) 容量 set::size set::max_size set::empty 觀察器 set::key_comp set::value_comp 修改器 set::clear set::erase set::swap set::extract (C++17) set::merge (C++17) set::insert set::insert_range (C++23) set::emplace (C++11) set::emplace_hint (C++11) 查找 set::count set::find set::contains (C++20)    set::equal_range set::lower_bound set::upper_bound

非成員函式

operator==operator<=> (C++20 起) std::swap(std::set) erase_if(std::set) (C++20)   operator!=operator<operator>operator<=operator>= (C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20 前)

推導指引(C++17)

 

定義於標頭檔 <set>
template<     class Key,     class Compare = std::less<Key>,     class Allocator = std::allocator<Key> > class set;	(1)
namespace pmr {     template<         class Key,         class Compare = std::less<Key>     > using set = std::set<Key, Compare, std::pmr::polymorphic_allocator<Key>>; }	(2)	(自 C++17 起)

std::set 是一種關聯容器，包含一組已排序且唯一的 Key 型別物件。排序是使用鍵比較函式 Compare 來完成的。搜尋、刪除和插入操作具有對數複雜度。集合通常實作為紅黑樹。

在標準程式庫使用 Compare 需求的任何地方，唯一性皆透過等價關係來判定。用不嚴謹的話說，若兩個物件 a 與 b 互不小於對方，則視為等價：!comp(a, b) && !comp(b, a)。

std::set 符合 容器 (Container)、配置器感知容器 (AllocatorAwareContainer)、關聯容器 (AssociativeContainer) 及 可逆容器 (ReversibleContainer) 的需求。

std::set 的所有成員函式皆為 constexpr：在常數表達式的求值過程中，可以建立並使用 std::set 物件。 然而，std::set 物件通常無法成為 constexpr，因為任何動態配置的儲存空間必須在同一個常數表達式求值過程中釋放。

（C++26 起）

成員型別

類型	定義
key_type	Key
value_type	Key
size_type	無號整數型別（通常為 std::size_t）
difference_type	有號整數型別（通常為 std::ptrdiff_t）
key_compare	Compare
value_compare	Compare
allocator_type	Allocator
reference	value_type&
const_reference	const value_type&
pointer	Allocator::pointer (直到 C++11) std::allocator_traits<Allocator>::pointer （C++11 起）
const_pointer	Allocator::const_pointer (直到 C++11) std::allocator_traits<Allocator>::const_pointer （C++11 起）
iterator	指向 value_type 的常數 舊式雙向迭代器 (LegacyBidirectionalIterator) 以及 ConstexprIterator(自 C++26)
const_iterator	LegacyBidirectionalIterator 以及 ConstexprIterator(C++26 起)，指向 const value_type
reverse_iterator	std::reverse_iterator<iterator>
const_reverse_iterator	std::reverse_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 實例化。

成員函式

(建構子)	建構 set (公開成員函式)
(解構函式)	解構 set (公開成員函式)
operator=	指派值給容器 (公開成員函式)
get_allocator	回傳關聯的配置器 (公開成員函式)
迭代器
begincbegin (C++11)	回傳指向起點的反覆器 (公開成員函式)
endcend (C++11)	回傳指向終點的反覆器 (公開成員函式)
rbegincrbegin (C++11)	回傳指向起點的反向反覆器 (公開成員函式)
rendcrend (C++11)	回傳指向終點的反向反覆器 (公開成員函式)
容量
empty	檢查容器是否為空 (公開成員函式)
size	回傳元素個數 (公開成員函式)
max_size	回傳最大可能的元素個數 (公開成員函式)
修改器
clear	清除內容 (公開成員函式)
insert	插入元素 或節點(C++17 起) (公開成員函式)
insert_range (C++23)	插入數值範圍元素 (公開成員函式)
emplace (C++11)	原地建構元素 (公開成員函式)
emplace_hint (C++11)	使用提示（hint）原地建構元素 (公開成員函式)
erase	刪除元素 (公開成員函式)
swap	交換內容 (公開成員函式)
extract (C++17)	從容器中提取節點 (公開成員函式)
merge (C++17)	從另一個容器接合（splice）節點 (公開成員函式)
查找
count	回傳符合指定鍵的元素數量 (公開成員函式)
find	尋找具有指定鍵的元素 (公開成員函式)
contains (C++20)	檢查容器是否包含具有指定鍵的元素 (公開成員函式)
equal_range	回傳與特定鍵相匹配的元素範圍 (公開成員函式)
lower_bound	回傳指向第一個「不小於」給定鍵之元素的迭代器 (公開成員函式)
upper_bound	回傳指向第一個「大於」給定鍵之元素的迭代器 (公開成員函式)
觀察器
key_comp	回傳比較鍵的函式 (公開成員函式)
value_comp	回傳比較 value_type 型別物件中鍵的函式 (公開成員函式)

非成員函式

operator==operator!=operator<operator<=operator>operator>=operator<=> (於 C++20 中移除)(於 C++20 中移除)(於 C++20 中移除)(於 C++20 中移除)(於 C++20 中移除)(自 C++20 起)	按字典序比較兩個 set 的值 (函式模板)
std::swap(std::set)	特化 std::swap 演算法 (函式範本)
erase_if(std::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::set

範例

執行此程式碼

#include <algorithm>
#include <iomanip>
#include <iostream>
#include <iterator>
#include <set>
#include <string_view>
 
template<typename T>
std::ostream& operator<<(std::ostream& out, const std::set<T>& set)
{
    if (set.empty())
        return out << "{}";
    out << "{ " << *set.begin();
    std::for_each(std::next(set.begin()), set.end(), [&out](const T& element)
    {
        out << ", " << element;
    });
    return out << " }";
}
 
int main()
{
    std::set<int> set{1, 5, 3};
    std::cout << set << '\n';
 
    set.insert(2);
    std::cout << set << '\n';
 
    set.erase(1);
    std::cout << set << "\n\n";
 
    std::set<int> keys{3, 4};
    for (int key : keys)
    {
        if (set.contains(key))
            std::cout << set << " does contain " << key << '\n';
        else
            std::cout << set << " doesn't contain " << key << '\n';
    }
    std::cout << '\n';
 
    std::string_view word = "element";
    std::set<char> characters(word.begin(), word.end());
    std::cout << "There are " << characters.size() << " unique characters in "
              << std::quoted(word) << ":\n" << characters << '\n';
}

輸出

{ 1, 3, 5 }
{ 1, 2, 3, 5 }
{ 2, 3, 5 }
 
{ 2, 3, 5 } does contain 3
{ 2, 3, 5 } doesn't contain 4
 
There are 5 unique characters in "element":
{ e, l, m, n, t }

缺陷報告

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

DR	應用於	出版時的行為	正確的行為
LWG 103	C++98	迭代器允許修改鍵	迭代器變為常數
LWG 230	C++98	Key 不強制要求為 可複製建構 (CopyConstructible) (Key 型別的鍵可能無法被建構)	Key 也被要求必須 為 CopyConstructible

參見

multiset	鍵的集合，按鍵排序 (類別樣板)
unordered_set (C++11)	唯一鍵的集合，按鍵雜湊 (類別範本)
flat_set (C++23)	適配容器以提供按鍵排序的唯一鍵集合 (類別樣板)