Defined in header
template<classKey,classHash=std::hash<Key>,classKeyEqual=std::equal_to<Key>,classAllocator=std::allocator<Key>>classunordered_set; (1) (since C++11)namespacepmr{template<classKey,classHash=std::hash<Key>,classPred=std::equal_to<Key>>usingunordered_set=std::unordered_set<Key,Hash,Pred,std::pmr::polymorphic_allocator<Key>>;} (2) (since C++17)std::unordered_set is an associative container that contains a set of unique objects of type Key. Search, insertion, and removal have average constant-time complexity.
Internally, the elements are not sorted in any particular order, but organized into buckets. Which bucket an element is placed into depends entirely on the hash of its value. This allows fast access to individual elements, since once a hash is computed, it refers to the exact bucket the element is placed into.
Container elements may not be modified (even by non const iterators) since modification could change an element's hash and corrupt the container.
std::unordered_set meets the requirements of
,
,
.
All member functions of std::unordered_set are constexpr: it is possible to create and use std::unordered_set objects in the evaluation of a constant expression.
However, defining a constexprstd::unordered_set variable is generally an error, because constant evaluation requires any dynamically allocated storage to be released in the same evaluation, which is usually not the case with std::unordered_set's initializer.
(since C++26)Iterator invalidation
Operations Invalidated All read only operations,
,
Never
,
,
,
Always
,
,
Only if causes rehash
Only to the element erased Notes
The swap functions do not invalidate any of the iterators inside the container, but they do invalidate the iterator marking the end of the swap region.
References and pointers to data stored in the container are only invalidated by erasing that element, even when the corresponding iterator is invalidated.
After container move assignment, unless elementwise move assignment is forced by incompatible allocators, references, pointers, and iterators (other than the past-the-end iterator) to moved-from container remain valid, but refer to elements that are now in *this.
Template parameters
Member types
Type Definition key_typeKey
value_typeKey
size_typeunsigned integer type (usually
)
difference_typesigned integer type (usually
)
hasherHash
key_equalKeyEqual
allocator_typeAllocator
referencevalue_type&
const_referenceconstvalue_type&
pointerstd::allocator_traits<Allocator>::pointer
const_pointerstd::allocator_traits<Allocator>::const_pointer
iteratorConstant
and
(since C++26) to value_type
const_iterator
and
(since C++26) to constvalue_type
local_iteratoran iterator type whose category, value, difference, pointer and
reference types are the same as iterator. This iterator
can be used to iterate through a single bucket but not across buckets
const_local_iteratoran iterator type whose category, value, difference, pointer and
reference types are the same as const_iterator. This iterator
can be used to iterate through a single bucket but not across buckets
node_type(since C++17)a specialization of
representing a container node
insert_return_type(since C++17)type describing the result of inserting a node_type, a specialization of template<classIter,classNodeType>struct/* unspecified */{Iterposition;boolinserted;NodeTypenode;};instantiated with template arguments iterator and node_type.
Member functions
constructs the unordered_set
(public member function)
destructs the unordered_set
(public member function)
assigns values to the container
(public member function)
returns the associated allocator
(public member function)
Iterators
returns an iterator to the beginning
(public member function)
returns an iterator to the end
(public member function)
Capacity
checks whether the container is empty
(public member function)
returns the number of elements
(public member function)
returns the maximum possible number of elements
(public member function)
Modifiers
clears the contents
(public member function)
inserts elements or nodes(since C++17)
(public member function)
(C++23)
inserts a range of elements
(public member function)
constructs element in-place
(public member function)
constructs elements in-place using a hint
(public member function)
erases elements
(public member function)
swaps the contents
(public member function)
(C++17)
extracts nodes from the container
(public member function)
(C++17)
splices nodes from another container
(public member function)
Lookup
returns the number of elements matching specific key
(public member function)
finds element with specific key
(public member function)
(C++20)
checks if the container contains element with specific key
(public member function)
returns range of elements matching a specific key
(public member function)
Bucket interface
begin(size_type)cbegin(size_type)
returns an iterator to the beginning of the specified bucket
(public member function)
returns an iterator to the end of the specified bucket
(public member function)
returns the number of buckets
(public member function)
returns the maximum number of buckets
(public member function)
returns the number of elements in specific bucket
(public member function)
returns the bucket for specific key
(public member function)
Hash policy
returns average number of elements per bucket
(public member function)
manages maximum average number of elements per bucket
(public member function)
reserves at least the specified number of buckets and regenerates the hash table
(public member function)
reserves space for at least the specified number of elements and regenerates the hash table
(public member function)
Observers
returns function used to hash the keys
(public member function)
returns the function used to compare keys for equality
(public member function)
Non-member functions
Notes
The member types iterator and const_iterator may be aliases to the same type. This means defining a pair of function overloads using the two types as parameter types may violate the
. Since iterator is convertible to const_iterator, a single function with a const_iterator as parameter type will work instead.
macro ValueStdFeature
(C++23)Ranges construction and insertion for containers
__cpp_lib_constexpr_unordered_set
(C++26)Constexpr std::unordered_setExample
Run this code
#include<iostream>#include<unordered_set>voidprint(constauto&set){for(constauto&elem:set)std::cout<<elem<<' ';std::cout<<'\n';}intmain(){std::unordered_set<int>mySet{2,7,1,8,2,8};// creates a set of intsprint(mySet);mySet.insert(5);// puts an element 5 in the setprint(mySet);if(autoiter=mySet.find(5);iter!=mySet.end())mySet.erase(iter);// removes an element pointed to by iterprint(mySet);mySet.erase(7);// removes an element 7print(mySet);}Possible output:
8 1 7 2 5 8 1 7 2 8 1 7 2 8 1 2 Defect reports
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
DR Applied to Behavior as published Correct behavior
C++11 the definitions of reference, const_reference, pointer
and const_pointer were based on allocator_typebased on value_type and
See also
(C++11)
collection of keys, hashed by keys
(class template)
collection of unique keys, sorted by keys
(class template)
(C++23)
adapts a container to provide a collection of unique keys, sorted by keys
(class template)