Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/container/unordered set"

From cppreference.com
< cpp‎ | container
m (Text replace - "{{tdcl list begin}} {{tdcl list h1 | Member types}}" to "===Member types=== {{tdcl list begin}}")
m (→‎Member types: ~Type)
 
(49 intermediate revisions by 18 users not shown)
Line 1: Line 1:
 
{{cpp/title|unordered_set}}
 
{{cpp/title|unordered_set}}
−
{{cpp/container/unordered_set/sidebar}}
+
{{cpp/container/unordered_set/navbar}}
−
{{ddcl | header=unordered_set | notes={{mark c++11 feature}} |
+
{{dcl begin}}
 +
{{dcl header|unordered_set}}
 +
{{dcl|num=1|since=c++11|1=
 
template<
 
template<
 
     class Key,
 
     class Key,
−
     class Hash {{=}} std::hash<Key>,
+
     class Hash = std::hash<Key>,
−
     class KeyEqual {{=}} std::equal_to<Key>,
+
     class KeyEqual = std::equal_to<Key>,
−
     class Allocator {{=}} std::allocator<Key>
+
     class Allocator = std::allocator<Key>
 
> class unordered_set;
 
> class unordered_set;
−
}}  
+
}}
 +
{{dcl|num=2|since=c++17|1=
 +
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>>;
 +
}
 +
}}
 +
{{dcl end}}
  
−
Unordered set is an associative container that contains set of unique objects of type Key.  
+
{{tt|std::unordered_set}} is an associative container that contains a set of unique objects of type {{tt|Key}}. Search, insertion, and removal have average constant-time complexity.
  
−
===Member types===
+
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.
−
{{tdcl list begin}}
+
−
{{tdcl list hitem | Member type | Definition}}
+
−
{{tdcl list template | cpp/container/tdcl list key_type | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list value_type | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list size_type | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list difference_type | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list hasher | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list key_equal | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list allocator_type | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list reference | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list const_reference | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list pointer | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list const_pointer | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list iterator | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list const_iterator | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list local_iterator | unordered_set}}
+
−
{{tdcl list template | cpp/container/tdcl list const_local_iterator | unordered_set}}
+
−
{{tdcl list end}}
+
  
 +
Container elements may not be modified (even by non const iterators) since modification could change an element's hash and corrupt the container.
  
 +
{{tt|std::unordered_set}} meets the requirements of {{named req|Container}}, {{named req|AllocatorAwareContainer}}, {{named req|UnorderedAssociativeContainer}}.
 +
 +
===Iterator invalidation===
 +
{|class="dsctable" style="font-size:1.0em"
 +
!Operations
 +
!Invalidated
 +
|-
 +
|All read only operations, {{lc|swap}}, {{lc|std::swap}}
 +
|Never
 +
|-
 +
|{{lc|clear}}, {{lc|rehash}}, {{lc|reserve}}, {{lc|1=operator=}}
 +
|Always
 +
|-
 +
|{{lc|insert}}, {{lc|emplace}}, {{lc|emplace_hint}}
 +
|Only if causes rehash
 +
|-
 +
|{{lc|erase}}
 +
|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 {{c|*this}}.
 +
 +
===Template parameters===
 +
{{todo|Add descriptions of the template parameters.}}
 +
 +
===Member types===
 +
{{dsc begin}}
 +
{{dsc hitem|Type|Definition}}
 +
{{dsc inc|cpp/container/dsc key_type|unordered_set}}
 +
{{dsc inc|cpp/container/dsc value_type|unordered_set}}
 +
{{dsc inc|cpp/container/dsc size_type|unordered_set}}
 +
{{dsc inc|cpp/container/dsc difference_type|unordered_set}}
 +
{{dsc inc|cpp/container/dsc hasher|unordered_set}}
 +
{{dsc inc|cpp/container/dsc key_equal|unordered_set}}
 +
{{dsc inc|cpp/container/dsc allocator_type|unordered_set}}
 +
{{dsc inc|cpp/container/dsc reference|unordered_set}}
 +
{{dsc inc|cpp/container/dsc const_reference|unordered_set}}
 +
{{dsc inc|cpp/container/dsc pointer|unordered_set}}
 +
{{dsc inc|cpp/container/dsc const_pointer|unordered_set}}
 +
{{dsc inc|cpp/container/dsc iterator|unordered_set}}
 +
{{dsc inc|cpp/container/dsc const_iterator|unordered_set}}
 +
{{dsc inc|cpp/container/dsc local_iterator|unordered_set}}
 +
{{dsc inc|cpp/container/dsc const_local_iterator|unordered_set}}
 +
{{dsc inc|cpp/container/dsc node_type|unordered_set}}
 +
{{dsc inc|cpp/container/dsc insert_return_type|unordered_set}}
 +
{{dsc end}}
  
 
===Member functions===
 
===Member functions===
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list template | cpp/container/dcl list constructor | unordered_set}}
+
{{dsc inc|cpp/container/dsc constructor|unordered_set}}
−
{{dcl list template | cpp/container/dcl list destructor | unordered_set}}
+
{{dsc inc|cpp/container/dsc destructor|unordered_set}}
−
{{dcl list template | cpp/container/dcl list operator{{=}} | unordered_set}}
+
{{dsc inc|cpp/container/dsc operator{{=}}|unordered_set}}
−
{{dcl list template | cpp/container/dcl list get_allocator | unordered_set}}
+
{{dsc inc|cpp/container/dsc get_allocator|unordered_set}}
 +
 
 +
{{dsc h2|Iterators}}
 +
{{dsc inc|cpp/container/dsc begin|unordered_set}}
 +
{{dsc inc|cpp/container/dsc end|unordered_set}}
 +
 
 +
{{dsc h2|Capacity}}
 +
{{dsc inc|cpp/container/dsc empty|unordered_set}}
 +
{{dsc inc|cpp/container/dsc size|unordered_set}}
 +
{{dsc inc|cpp/container/dsc max_size|unordered_set}}
 +
 
 +
{{dsc h2|Modifiers}}
 +
{{dsc inc|cpp/container/dsc clear|unordered_set}}
 +
{{dsc inc|cpp/container/dsc insert|unordered_set}}
 +
{{dsc inc|cpp/container/dsc insert_range|unordered_set}}
 +
{{dsc inc|cpp/container/dsc emplace|unordered_set}}
 +
{{dsc inc|cpp/container/dsc emplace_hint|unordered_set}}
 +
{{dsc inc|cpp/container/dsc erase|unordered_set}}
 +
{{dsc inc|cpp/container/dsc swap|unordered_set}}
 +
{{dsc inc|cpp/container/dsc extract|unordered_set}}
 +
{{dsc inc|cpp/container/dsc merge|unordered_set}}
 +
 
 +
{{dsc h2|Lookup}}
 +
{{dsc inc|cpp/container/dsc count|unordered_set}}
 +
{{dsc inc|cpp/container/dsc find|unordered_set}}
 +
{{dsc inc|cpp/container/dsc contains|unordered_set}}
 +
{{dsc inc|cpp/container/dsc equal_range|unordered_set}}
 +
 
 +
{{dsc h2|Bucket interface}}
 +
{{dsc inc|cpp/container/dsc begin(int)|unordered_set}}
 +
{{dsc inc|cpp/container/dsc end(int)|unordered_set}}
 +
{{dsc inc|cpp/container/dsc bucket_count|unordered_set}}
 +
{{dsc inc|cpp/container/dsc max_bucket_count|unordered_set}}
 +
{{dsc inc|cpp/container/dsc bucket_size|unordered_set}}
 +
{{dsc inc|cpp/container/dsc bucket|unordered_set}}
 +
 
 +
{{dsc h2|Hash policy}}
 +
{{dsc inc|cpp/container/dsc load_factor|unordered_set}}
 +
{{dsc inc|cpp/container/dsc max_load_factor|unordered_set}}
 +
{{dsc inc|cpp/container/dsc rehash|unordered_set}}
 +
{{dsc inc|cpp/container/dsc reserve|unordered_set}}
 +
 
 +
{{dsc h2|Observers}}
 +
{{dsc inc|cpp/container/dsc hash_function|unordered_set}}
 +
{{dsc inc|cpp/container/dsc key_eq|unordered_set}}
 +
{{dsc end}}
 +
 
 +
===Non-member functions===
 +
{{dsc begin}}
 +
{{dsc inc|cpp/container/dsc operator_cmp_unord|unordered_set}}
 +
{{dsc inc|cpp/container/dsc swap2|unordered_set}}
 +
{{dsc inc|cpp/container/dsc erase_if|unordered_set}}
 +
{{dsc end}}
 +
 
 +
{{rrev|since=c++17|
 +
==={{rl|deduction guides|Deduction guides}}===
 +
}}
  
−
{{dcl list h2 | Iterators}}
+
===Notes===
−
{{dcl list template | cpp/container/dcl list begin | unordered_set}}
+
{{cpp/container/assoc_note}}
−
{{dcl list template | cpp/container/dcl list end | unordered_set}}
+
  
−
{{dcl list h2 | Capacity}}
+
{{ftm begin|std=1|comment=1}}
−
{{dcl list template | cpp/container/dcl list empty | unordered_set}}
+
{{ftm|__cpp_lib_containers_ranges|value=202202L|std=C++23|Ranges construction and insertion for containers}}
−
{{dcl list template | cpp/container/dcl list size | unordered_set}}
+
{{ftm end}}
−
{{dcl list template | cpp/container/dcl list max_size | unordered_set}}
+
  
−
{{dcl list h2 | Modifiers}}
+
===Example===
−
{{dcl list template | cpp/container/dcl list clear | unordered_set}}
+
{{example
−
{{dcl list template | cpp/container/dcl list insert | unordered_set}}
+
|code=
−
{{dcl list template | cpp/container/dcl list emplace | unordered_set}}
+
#include <iostream>
−
{{dcl list template | cpp/container/dcl list emplace_hint | unordered_set}}
+
#include <unordered_set>
−
{{dcl list template | cpp/container/dcl list erase | unordered_set}}
+
−
{{dcl list template | cpp/container/dcl list swap | unordered_set}}
+
  
−
{{dcl list h2 | Lookup}}
+
void print(const auto& set)
−
{{dcl list template | cpp/container/dcl list count | unordered_set}}
+
{
−
{{dcl list template | cpp/container/dcl list find | unordered_set}}
+
    for (const auto& elem : set)
−
{{dcl list template | cpp/container/dcl list equal_range | unordered_set}}
+
        std::cout << elem << ' ';
 +
    std::cout << '\n';
 +
}
  
−
{{dcl list h2 | Bucket interface}}
+
int main()
−
{{dcl list template | cpp/container/dcl list begin(int) | unordered_set}}
+
{
−
{{dcl list template | cpp/container/dcl list end(int) | unordered_set}}
+
    std::unordered_set<int> mySet{2, 7, 1, 8, 2, 8}; // creates a set of ints
−
{{dcl list template | cpp/container/dcl list bucket_count | unordered_set}}
+
    print(mySet);
−
{{dcl list template | cpp/container/dcl list max_bucket_count | unordered_set}}
+
   
−
{{dcl list template | cpp/container/dcl list bucket_size | unordered_set}}
+
    mySet.insert(5); // puts an element 5 in the set
−
{{dcl list template | cpp/container/dcl list bucket | unordered_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);
 +
}
 +
|p=true
 +
|output=
 +
8 1 7 2
 +
5 8 1 7 2
 +
8 1 7 2
 +
8 1 2
 +
}}
  
−
{{dcl list h2 | Hash policy}}
+
===Defect reports===
−
{{dcl list template | cpp/container/dcl list load_factor | unordered_set}}
+
{{dr list begin}}
−
{{dcl list template | cpp/container/dcl list max_load_factor | unordered_set}}
+
{{dr list item|wg=lwg|dr=2050|std=C++11|before=the definitions of {{tt|reference}}, {{tt|const_reference}}, {{tt|pointer}}<br>and {{tt|const_pointer}} were based on {{tt|allocator_type}}|after=based on {{tt|value_type}} and<br>{{lc|std::allocator_traits}}}}
−
{{dcl list template | cpp/container/dcl list rehash | unordered_set}}
+
{{dr list end}}
−
{{dcl list template | cpp/container/dcl list reserve | unordered_set}}
+
  
−
{{dcl list h2 | Observers}}
+
===See also===
−
{{dcl list template | cpp/container/dcl list hash_function | unordered_set}}
+
{{dsc begin}}
−
{{dcl list template | cpp/container/dcl list key_eq | unordered_set}}
+
{{dsc inc|cpp/container/dsc unordered_multiset}}
 +
{{dsc inc|cpp/container/dsc set}}
 +
{{dsc inc|cpp/container/dsc flat_set}}
 +
{{dsc end}}
  
−
{{dcl list h1 | Non-member functions}}
+
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
−
{{dcl list template | cpp/container/dcl list operator_comp_unord | unordered_set}}
+
−
{{dcl list template | cpp/container/dcl list std_swap | unordered_set}}
+
−
{{dcl list end}}
+

Latest revision as of 15:44, 1 November 2024

 
C++
 
Containers library
 
std::unordered_set
Member types
Member functions
Non-member functions
(until C++20)
Deduction guides (C++17)
 
Defined in header <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) (since 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) (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 Container, AllocatorAwareContainer, UnorderedAssociativeContainer.

Contents

[edit] Iterator invalidation

Operations Invalidated
All read only operations, swap, std::swap Never
clear, rehash, reserve, operator= Always
insert, emplace, emplace_hint Only if causes rehash
erase Only to the element erased

[edit] 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.

[edit] Template parameters

This section is incomplete
Reason: Add descriptions of the template parameters.

[edit] Member types

Type Definition
key_type Key[edit]
value_type Key[edit]
size_type Unsigned integer type (usually std::size_t)[edit]
difference_type Signed integer type (usually std::ptrdiff_t)[edit]
hasher Hash[edit]
key_equal KeyEqual[edit]
allocator_type Allocator[edit]
reference value_type&[edit]
const_reference const value_type&[edit]
pointer std::allocator_traits<Allocator>::pointer[edit]
const_pointer std::allocator_traits<Allocator>::const_pointer[edit]
iterator Constant LegacyForwardIterator to value_type[edit]
const_iterator LegacyForwardIterator to const value_type[edit]
local_iterator An 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[edit]
const_local_iterator An 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[edit]
node_type (since C++17) a specialization of node handle representing a container node[edit]
insert_return_type (since C++17) type describing the result of inserting a node_type, a specialization of

template<class Iter, class NodeType>
struct /*unspecified*/
{
    Iter     position;
    bool     inserted;
    NodeType node;
};
instantiated with template arguments iterator and node_type.[edit]

[edit] Member functions

 constructs the unordered_set
(public member function) [edit]
destructs the unordered_set
(public member function) [edit]
assigns values to the container
(public member function) [edit]
returns the associated allocator
(public member function) [edit]
Iterators
returns an iterator to the beginning
(public member function) [edit]
returns an iterator to the end
(public member function) [edit]
Capacity
checks whether the container is empty
(public member function) [edit]
returns the number of elements
(public member function) [edit]
returns the maximum possible number of elements
(public member function) [edit]
Modifiers
clears the contents
(public member function) [edit]
inserts elements or nodes(since C++17)
(public member function) [edit]
(C++23)
 inserts a range of elements
(public member function) [edit]
constructs element in-place
(public member function) [edit]
constructs elements in-place using a hint
(public member function) [edit]
erases elements
(public member function) [edit]
swaps the contents
(public member function) [edit]
(C++17)
 extracts nodes from the container
(public member function) [edit]
(C++17)
 splices nodes from another container
(public member function) [edit]
Lookup
returns the number of elements matching specific key
(public member function) [edit]
finds element with specific key
(public member function) [edit]
(C++20)
 checks if the container contains element with specific key
(public member function) [edit]
returns range of elements matching a specific key
(public member function) [edit]
Bucket interface
returns an iterator to the beginning of the specified bucket
(public member function) [edit]
returns an iterator to the end of the specified bucket
(public member function) [edit]
returns the number of buckets
(public member function) [edit]
returns the maximum number of buckets
(public member function) [edit]
returns the number of elements in specific bucket
(public member function) [edit]
returns the bucket for specific key
(public member function) [edit]
Hash policy
returns average number of elements per bucket
(public member function) [edit]
manages maximum average number of elements per bucket
(public member function) [edit]
reserves at least the specified number of buckets and regenerates the hash table
(public member function) [edit]
reserves space for at least the specified number of elements and regenerates the hash table
(public member function) [edit]
Observers
returns function used to hash the keys
(public member function) [edit]
returns the function used to compare keys for equality
(public member function) [edit]

[edit] Non-member functions

(C++11)(C++11)(removed in C++20)
 compares the values in the unordered_set
(function template) [edit]
(C++11)
 specializes the std::swap algorithm
(function template) [edit]
(C++20)
 erases all elements satisfying specific criteria
(function template) [edit]

Deduction guides

 (since C++17)

[edit] 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 One Definition Rule. Since iterator is convertible to const_iterator, a single function with a const_iterator as parameter type will work instead.

Feature-test macro Value Std Feature
__cpp_lib_containers_ranges 202202L (C++23) Ranges construction and insertion for containers

[edit] Example

Run this code
#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);
}

Possible output: 

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

[edit] Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR Applied to Behavior as published Correct behavior
LWG 2050 C++11 the definitions of reference, const_reference, pointer
and const_pointer were based on allocator_type 		based on value_type and
std::allocator_traits

[edit] See also

(C++11)
 collection of keys, hashed by keys
(class template) [edit]
collection of unique keys, sorted by keys
(class template) [edit]
(C++23)
 adapts a container to provide a collection of unique keys, sorted by keys
(class template) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/container/unordered_set&oldid=177449"