# std::unordered_set

From cppreference.com
< cpp‎ | container

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)

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`.

### Member types

Member type | Definition
`key_type` | `Key`
`value_type` | `Key`
`size_type` | Unsigned integer type (usually std::size_t)
`difference_type` | Signed integer type (usually 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` | Constant `ForwardIterator`
`const_iterator` | Constant forward iterator
`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
`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
`node_type` | a specialization of node handle representing a container node (since C++17)

`insert_return_type`

type describing the result of inserting a `node_type`, a specialization of

    template <class Iterator, class NodeType> struct /*unspecified*/ {
        Iterator position;
        bool     inserted;
        NodeType node;
    };

instantiated with template arguments `iterator` and `node_type`. (since C++17)

### Member functions

(constructor) | constructs the `unordered_set` (public member function)
(destructor) | destructs the `unordered_set` (public member function)
operator= | assigns values to the container (public member function)
get_allocator | returns the associated allocator (public member function)

##### Iterators

begin cbegin | returns an iterator to the beginning (public member function)
end cend | returns an iterator to the end (public member function)

##### Capacity

empty | checks whether the container is empty (public member function)
size | returns the number of elements (public member function)
max_size | returns the maximum possible number of elements (public member function)

##### Modifiers

clear | clears the contents (public member function)
insert | inserts elements or nodes (since C++17) (public member function)
emplace | constructs element in-place (public member function)
emplace_hint | constructs elements in-place using a hint (public member function)
erase | erases elements (public member function)
swap | swaps the contents (public member function)
extract (C++17) | extracts nodes from the container (public member function)
merge (C++17) | splices nodes from another container (public member function)

##### Lookup

count | returns the number of elements matching specific key (public member function)
find | finds element with specific key (public member function)
equal_range | returns range of elements matching a specific key (public member function)

##### Bucket interface

begin(int) cbegin(int) | returns an iterator to the beginning of the specified bucket (public member function)
end(int) cend(int) | returns an iterator to the end of the specified bucket (public member function)
bucket_count | returns the number of buckets (public member function)
max_bucket_count | returns the maximum number of buckets (public member function)
bucket_size | returns the number of elements in specific bucket (public member function)
bucket | returns the bucket for specific key (public member function)

##### Hash policy

load_factor | returns average number of elements per bucket (public member function)
max_load_factor | manages maximum average number of elements per bucket (public member function)
rehash | reserves at least the specified number of buckets. This regenerates the hash table. (public member function)
reserve | reserves space for at least the specified number of elements. This regenerates the hash table. (public member function)

##### Observers

hash_function | returns function used to hash the keys (public member function)
key_eq | returns the function used to compare keys for equality (public member function)

### Non-member functions

operator==operator!= | compares the values in the unordered_set (function template)
std::swap(std::unordered_set) (C++11) | specializes the std::swap algorithm (function template)

### Notes

The member types `iterator` and `const_iterator` may be aliases to the same type. Since `iterator` is convertible to `const_iterator`, `const_iterator` should be used in function parameter lists to avoid violations of the One Definition Rule.

Retrieved from "http://en.cppreference.com/mwiki/index.php?title=cpp/container/unordered_set&oldid=89134"