Difference between revisions of "cpp/container/unordered set"
(+pmr.. I am actually not sure now whether this is better to go for maximum exposure by placing pmrs in the top of the page, or making a sections like for various "helper template aliases" elsewhere) |
m ((forgot the namespace)) |
||
| Line 12: | Line 12: | ||
}} | }} | ||
{{dcl|num=2|since=c++17|1= | {{dcl|num=2|since=c++17|1= | ||
| + | namespace pmr { | ||
template <class Key, | template <class Key, | ||
class Hash = std::hash<Key>, | class Hash = std::hash<Key>, | ||
| Line 17: | Line 18: | ||
using unordered_set = std::unordered_set<Key, Hash, Pred, | using unordered_set = std::unordered_set<Key, Hash, Pred, | ||
std::polymorphic_allocator<Key>>; | std::polymorphic_allocator<Key>>; | ||
| + | } | ||
}} | }} | ||
{{dcl end}} | {{dcl end}} | ||
Revision as of 07:41, 16 March 2016
| Defined in header <unordered_set>
|
||
| template< class Key, |
(1) | (since C++11) |
| namespace pmr { template <class 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.
std::unordered_set meets the requirements of Template:concept, Template:concept, Template:concept.
Contents |
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 LegacyForwardIterator to value_type
|
const_iterator
|
LegacyForwardIterator to const value_type |
local_iterator
|
An iterator type whose category, value, difference, pointer and reference types are the same as iterator. This iteratorcan 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 iteratorcan be used to iterate through a single bucket but not across buckets |
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) | |
| 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) | |
Lookup | |
| returns the number of elements matching specific key (public member function) | |
| finds element with specific key (public member function) | |
| returns range of elements matching a specific key (public member function) | |
Bucket interface | |
| 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
| (C++11)(C++11)(removed in C++20) |
compares the values in the unordered_set (function template) |
| specializes the std::swap algorithm (function template) |
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.
