![]() |
Home | Libraries | People | FAQ | More |
boost::unordered_map — An unordered associative container that associates unique keys with another value.
// In header: <boost/unordered_map.hpp> template<typename Key, typename Mapped, typename Hash, typename Pred, typename Alloc> class unordered_map { public: // types typedef ; typedef ; typedef ; typedef ; typedef ; typedef ; typedef ; typedef ; typedef ; // lvalue of value_type. typedef ; // const lvalue of value_type. typedef ; typedef ; typedef ; typedef ; typedef ; typedef ; typedef ; typedef ; // construct/copy/destruct (); (, = , = , = ); template<typename InputIterator> (, , = , = , = , = ); (); (); (); (, ); (, ); (, = , = , = , = ); (, ); (, , ); template<typename InputIterator> (, , , ); template<typename InputIterator> (, , , , ); ~(); (); (); (); () ; // size and capacity () ; () ; () ; // iterators (); () ; (); () ; () ; () ; // modifiers template<typename... Args> (...); template<typename... Args> (, ...); (); (); (, ); (, ); template<typename InputIterator> (, ); (); (); (); (); (); (, ); (); (); (, ); (); (); (); (); template<typename H2, typename P2> (); template<typename H2, typename P2> (); // observers () ; () ; // lookup (); () ; template<typename CompatibleKey, typename CompatibleHash, typename CompatiblePredicate> (, , ); template<typename CompatibleKey, typename CompatibleHash, typename CompatiblePredicate> (, , ) ; () ; (); () ; (); (); () ; // bucket interface () ; () ; () ; () ; (); () ; (); () ; () ; (); // hash policy () ; () ; (); (); (); }; // Equality Comparisons template<typename Key, typename Mapped, typename Hash, typename Pred, typename Alloc> (, ); template<typename Key, typename Mapped, typename Hash, typename Pred, typename Alloc> (, ); // swap template<typename Key, typename Mapped, typename Hash, typename Pred, typename Alloc> (, );
Template Parameters
Key |
Key must be Erasable from the container
(i.e. allocator_traits can destroy it).
|
Mapped |
Mapped must be Erasable from the container
(i.e. allocator_traits can destroy it).
|
Hash | A unary function object type that acts a hash function for a Key . It takes a single argument of type Key and returns a value of type std::size_t. |
Pred | A binary function object that implements an equivalence relation on values of type Key .
A binary function object that induces an equivalence relation on values of type Key .
It takes two arguments of type Key and returns a value of type bool. |
Alloc | An allocator whose value type is the same as the container's value type. |
The elements are organized into buckets. Keys with the same hash code are stored in the same bucket.
The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash.
unordered_map
public
types
value_type*
if
allocator_type::pointer
is not defined.
boost::pointer_to_other<pointer, value_type>::type
if allocator_type::const_pointer
is not defined.
An unsigned integral type.
size_type can represent any non-negative value of difference_type.
A signed integral type.
Is identical to the difference type of iterator and const_iterator.
An iterator whose value type is value_type.
The iterator category is at least a forward iterator.
Convertible to const_iterator.
A constant iterator whose value type is value_type.
The iterator category is at least a forward iterator.
An iterator with the same value type, difference type and pointer and reference type as iterator.
A local_iterator object can be used to iterate through a single bucket.
A constant iterator with the same value type, difference type and pointer and reference type as const_iterator.
A const_local_iterator object can be used to iterate through a single bucket.
See node_handle_map for details.
node_type
.
unordered_map
public
construct/copy/destruct();
Constructs an empty container using hasher() as the hash function, key_equal() as the key equality predicate, allocator_type() as the allocator and a maximum load factor of 1.0.
Postconditions: |
size() == 0 |
Requires: |
If the defaults are used, |
( n, hf = , eq = , a = );
Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocator and a maximum load factor of 1.0.
Postconditions: |
size() == 0 |
Requires: |
If the defaults are used, |
template<typename InputIterator> ( f, l, n = , hf = , eq = , a = );
Constructs an empty container with at least n
buckets,
using hf
as the hash function,
eq
as the key equality predicate,
a
as the allocator and a maximum load factor of 1.0
and inserts the elements from [f, l) into it.
Requires: |
If the defaults are used, |
();
The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator.
If Allocator::select_on_container_copy_construction
exists and has the right signature, the allocator will be
constructed from its result.
Requires: |
|
();
The move constructor.
Notes: |
This is implemented using Boost.Move. |
Requires: |
On compilers without rvalue reference support the
emulation does not support moving without calling
|
( a);
Constructs an empty container, using allocator a
.
( x, a);
Constructs an container, copying x
's contained elements, hash function, predicate, maximum load factor, but using allocator a
.
( x, a);
Construct a container moving x
's contained elements, and having the hash function, predicate and maximum load factor, but using allocate a
.
Notes: |
This is implemented using Boost.Move. |
Requires: |
|
( il, n = , hf = , eq = , a = );
Constructs an empty container with at least n
buckets,
using hf
as the hash function,
eq
as the key equality predicate,
a
as the allocator and a maximum load factor of 1.0
and inserts the elements from il
into it.
Requires: |
If the defaults are used, |
( n, a);
Constructs an empty container with at least n
buckets,
using hf
as the hash function,
the default hash function and key equality predicate,
a
as the allocator and a maximum load factor of 1.0.
Postconditions: |
size() == 0 |
Requires: |
|
( n, hf, a);
Constructs an empty container with at least n
buckets,
using hf
as the hash function,
the default key equality predicate,
a
as the allocator and a maximum load factor of 1.0.
Postconditions: |
size() == 0 |
Requires: |
|
template<typename InputIterator> ( f, l, n, a);
Constructs an empty container with at least n
buckets,
using a
as the allocator, with the
default hash function and key equality predicate
and a maximum load factor of 1.0
and inserts the elements from [f, l) into it.
Requires: |
|
template<typename InputIterator> ( f, l, n, hf, a);
Constructs an empty container with at least n
buckets,
using hf
as the hash function,
a
as the allocator, with the
default key equality predicate
and a maximum load factor of 1.0
and inserts the elements from [f, l) into it.
Requires: |
|
~();
Notes: |
The destructor is applied to every element, and all memory is deallocated |
();
The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator.
If Alloc::propagate_on_container_copy_assignment
exists and Alloc::propagate_on_container_copy_assignment::value
is true, the allocator is overwritten, if not the
copied elements are created using the existing
allocator.
Requires: |
|
();
The move assignment operator.
If Alloc::propagate_on_container_move_assignment
exists and Alloc::propagate_on_container_move_assignment::value
is true, the allocator is overwritten, if not the
moved elements are created using the existing
allocator.
Notes: |
On compilers without rvalue references, this is emulated using Boost.Move. Note that on some compilers the copy assignment operator may be used in some circumstances. |
Requires: |
|
();
Assign from values in initializer list. All existing elements are either overwritten by the new elements or destroyed.
Requires: |
|
() ;
unordered_map
iterators(); () ;
Returns: |
An iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container. |
(); () ;
Returns: |
An iterator which refers to the past-the-end value for the container. |
() ;
Returns: |
A constant iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container. |
() ;
Returns: |
A constant iterator which refers to the past-the-end value for the container. |
unordered_map
modifierstemplate<typename... Args> (... args);
Inserts an object, constructed with the arguments args
, in the container if and only if there is no element in the container with an equivalent key.
Requires: |
|
Returns: |
The bool component of the return type is true if an insert took place. If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key. |
Throws: |
If an exception is thrown by an operation other than a call to |
Notes: |
Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. Pointers and references to elements are never invalidated. If the compiler doesn't support variadic template arguments or rvalue references, this is emulated for up to 10 arguments, with no support for rvalue references or move semantics. Since existing |
template<typename... Args> ( hint, ... args);
Inserts an object, constructed with the arguments args
, in the container if and only if there is no element in the container with an equivalent key.
hint
is a suggestion to where the element should be inserted.
Requires: |
|
Returns: |
If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key. |
Throws: |
If an exception is thrown by an operation other than a call to |
Notes: |
The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same key. Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. Pointers and references to elements are never invalidated. If the compiler doesn't support variadic template arguments or rvalue references, this is emulated for up to 10 arguments, with no support for rvalue references or move semantics. Since existing |
( obj);
Inserts obj
in the container if and only if there is no element in the container with an equivalent key.
Requires: |
|
Returns: |
The bool component of the return type is true if an insert took place. If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key. |
Throws: |
If an exception is thrown by an operation other than a call to |
Notes: |
Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. Pointers and references to elements are never invalidated. |
( obj);
Inserts obj
in the container if and only if there is no element in the container with an equivalent key.
Requires: |
|
Returns: |
The bool component of the return type is true if an insert took place. If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key. |
Throws: |
If an exception is thrown by an operation other than a call to |
Notes: |
Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. Pointers and references to elements are never invalidated. |
( hint, obj);
Inserts obj
in the container if and only if there is no element in the container with an equivalent key.
hint is a suggestion to where the element should be inserted.
Requires: |
|
Returns: |
If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key. |
Throws: |
If an exception is thrown by an operation other than a call to |
Notes: |
The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same key. Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. Pointers and references to elements are never invalidated. |
( hint, obj);
Inserts obj
in the container if and only if there is no element in the container with an equivalent key.
hint is a suggestion to where the element should be inserted.
Requires: |
|
Returns: |
If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key. |
Throws: |
If an exception is thrown by an operation other than a call to |
Notes: |
The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same key. Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. Pointers and references to elements are never invalidated. |
template<typename InputIterator> ( first, last);
Inserts a range of elements into the container. Elements are inserted if and only if there is no element in the container with an equivalent key.
Requires: |
|
Throws: |
When inserting a single element, if an exception is thrown by an operation other than a call to |
Notes: |
Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. Pointers and references to elements are never invalidated. |
( il);
Inserts a range of elements into the container. Elements are inserted if and only if there is no element in the container with an equivalent key.
Requires: |
|
Throws: |
When inserting a single element, if an exception is thrown by an operation other than a call to |
Notes: |
Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. Pointers and references to elements are never invalidated. |
( il);
Inserts a range of elements into the container. Elements are inserted if and only if there is no element in the container with an equivalent key.
Requires: |
|
Throws: |
When inserting a single element, if an exception is thrown by an operation other than a call to |
Notes: |
Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. Pointers and references to elements are never invalidated. |
( position);
Removes the element pointed to by position
.
Returns: |
A |
Notes: |
In C++17 a node extracted using this method can be inserted into a compatible |
( k);
Removes an element with key equivalent to k
.
Returns: |
A |
Throws: |
Only throws an exception if it is thrown by |
Notes: |
In C++17 a node extracted using this method can be inserted into a compatible |
( nh);
If nh
is empty, has no affect.
Otherwise inserts the element owned by nh
if and only if there is no element in the container with an equivalent key.
Requires: |
|
Returns: |
If Otherwise if there was already an element with an equivalent key, returns an Otherwise if the insertion succeeded, returns an |
Throws: |
If an exception is thrown by an operation other than a call to |
Notes: |
Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. Pointers and references to elements are never invalidated. In C++17 this can be used to insert a node extracted from a compatible |
( hint, nh);
If nh
is empty, has no affect.
Otherwise inserts the element owned by nh
if and only if there is no element in the container with an equivalent key.
If there is already an element in the container with an equivalent key has no effect on nh
(i.e. nh
still contains the node.)
hint is a suggestion to where the element should be inserted.
Requires: |
|
Returns: |
If If there was already an element in the container with an equivalent key returns an iterator pointing to that. Otherwise returns an iterator pointing to the newly inserted element. |
Throws: |
If an exception is thrown by an operation other than a call to |
Notes: |
The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same key. Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. Pointers and references to elements are never invalidated. In C++17 this can be used to insert a node extracted from a compatible |
( position);
Erase the element pointed to by position
.
Returns: |
The iterator following |
Throws: |
Only throws an exception if it is thrown by |
Notes: |
In older versions this could be inefficient because it had to search through several buckets to find the position of the returned iterator. The data structure has been changed so that this is no longer the case, and the alternative erase methods have been deprecated. |
( k);
Erase all elements with key equivalent to k
.
Returns: |
The number of elements erased. |
Throws: |
Only throws an exception if it is thrown by |
( first, last);
Erases the elements in the range from first
to last
.
Returns: |
The iterator following the erased elements - i.e. |
Throws: |
Only throws an exception if it is thrown by In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. |
( position);
Erase the element pointed to by position
.
Throws: |
Only throws an exception if it is thrown by In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. |
Notes: |
This method was implemented because returning an iterator to
the next element from |
( position);
Erase the element pointed to by position
.
Throws: |
Only throws an exception if it is thrown by In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. |
Notes: |
This method was implemented because returning an iterator to
the next element from |
();
Erases all elements in the container.
Postconditions: |
|
Throws: |
Never throws an exception. |
();
Swaps the contents of the container with the parameter.
If Allocator::propagate_on_container_swap
is declared and
Allocator::propagate_on_container_swap::value
is true then the
containers' allocators are swapped. Otherwise, swapping with unequal allocators
results in undefined behavior.
Throws: |
Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of |
Notes: |
The exception specifications aren't quite the same as the C++11 standard, as the equality predieate and hash function are swapped using their copy constructors. |
template<typename H2, typename P2> ( source);
Notes: |
Does not support merging with a compatible |
template<typename H2, typename P2> ( source);
Notes: |
Does not support merging with a compatible |
unordered_map
lookup( k); ( k) ; template<typename CompatibleKey, typename CompatibleHash, typename CompatiblePredicate> ( k, hash, eq); template<typename CompatibleKey, typename CompatibleHash, typename CompatiblePredicate> ( k, hash, eq) ;
Returns: |
An iterator pointing to an element with key equivalent to |
Notes: |
The templated overloads are a non-standard extensions which allows you to use a compatible hash function and equality predicate for a key of a different type in order to avoid an expensive type cast. In general, its use is not encouraged. |
( k) ;
Returns: |
The number of elements with key equivalent to |
( k); ( k) ;
Returns: |
A range containing all elements with key equivalent to |
( k);
Effects: |
If the container does not already contain an elements with a key equivalent to |
Returns: |
A reference to |
Throws: |
If an exception is thrown by an operation other than a call to |
Notes: |
Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. Pointers and references to elements are never invalidated. |
( k); ( k) ;
Returns: |
A reference to |
Throws: |
An exception object of type |
unordered_map
bucket interface() ;
Returns: |
The number of buckets. |
() ;
Returns: |
An upper bound on the number of buckets. |
( n) ;
Requires: |
|
Returns: |
The number of elements in bucket |
( k) ;
Returns: |
The index of the bucket which would contain an element with key |
Postconditions: |
The return value is less than |
( n); ( n) ;
Requires: |
|
Returns: |
A local iterator pointing the first element in the bucket with index |
( n); ( n) ;
Requires: |
|
Returns: |
A local iterator pointing the 'one past the end' element in the bucket with index |
( n) ;
Requires: |
|
Returns: |
A constant local iterator pointing the first element in the bucket with index |
( n);
Requires: |
|
Returns: |
A constant local iterator pointing the 'one past the end' element in the bucket with index |
unordered_map
hash policy() ;
Returns: |
The average number of elements per bucket. |
() ;
Returns: |
Returns the current maximum load factor. |
( z);
Effects: |
Changes the container's maximum load factor, using |
( n);
Changes the number of buckets so that there at least n
buckets, and so that the load factor is less than the maximum load factor.
Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.
Throws: |
The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. |
( n);
Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.
Throws: |
The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. |
unordered_map
Equality Comparisonstemplate<typename Key, typename Mapped, typename Hash, typename Pred, typename Alloc> ( x, y);
Return true
if x.size() ==
y.size
and for every element in x
,
there is an element in y
with the same
for the same key, with an equal value (using
operator==
to compare the value types).
Notes: |
The behavior of this function was changed to match the C++11 standard in Boost 1.48. Behavior is undefined if the two containers don't have equivalent equality predicates. |
template<typename Key, typename Mapped, typename Hash, typename Pred, typename Alloc> ( x, y);
Return false
if x.size() ==
y.size
and for every element in x
,
there is an element in y
with the same
for the same key, with an equal value (using
operator==
to compare the value types).
Notes: |
The behavior of this function was changed to match the C++11 standard in Boost 1.48. Behavior is undefined if the two containers don't have equivalent equality predicates. |
unordered_map
swaptemplate<typename Key, typename Mapped, typename Hash, typename Pred, typename Alloc> ( x, y);
Swaps the contents of x
and y
.
If Allocator::propagate_on_container_swap
is declared and
Allocator::propagate_on_container_swap::value
is true then the
containers' allocators are swapped. Otherwise, swapping with unequal allocators
results in undefined behavior.
Effects: |
|
Throws: |
Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of |
Notes: |
The exception specifications aren't quite the same as the C++11 standard, as the equality predieate and hash function are swapped using their copy constructors. |