| Home | Libraries | People | FAQ | More

## Class template unordered_map

boost::unordered_map — An unordered associative container that associates unique keys with another value.

## Synopsis

    // In header: <boost/unordered_map.hpp>

    template<typename Key, typename Mapped, typename Hash = boost::hash<Key>,
             typename Pred = std::equal_to<Key>,
             typename Alloc = std::allocator<std::pair<Key const, Mapped>> >
    class unordered_map {
    public:
      // types
      typedef Key                                    key_type;
      typedef std::pair<Key const, Mapped>           value_type;
      typedef Mapped                                 mapped_type;
      typedef Hash                                   hasher;
      typedef Pred                                   key_equal;
      typedef Alloc                                  allocator_type;
      typedef typename allocator_type::pointer       pointer;
      typedef typename allocator_type::const_pointer const_pointer;
      typedef value_type&                            reference;             // lvalue of value_type.
      typedef value_type const&                      const_reference;       // const lvalue of value_type.
      typedef implementation-defined                 size_type;
      typedef implementation-defined                 difference_type;
      typedef implementation-defined                 iterator;
      typedef implementation-defined                 const_iterator;
      typedef implementation-defined                 local_iterator;
      typedef implementation-defined                 const_local_iterator;

      // construct/copy/destruct
      explicit unordered_map(size_type = implementation-defined,
                             hasher const& = hasher(),
                             key_equal const& = key_equal(),
                             allocator_type const& = allocator_type());
      template<typename InputIterator>
        unordered_map(InputIterator, InputIterator,
                      size_type = implementation-defined,
                      hasher const& = hasher(), key_equal const& = key_equal(),
                      allocator_type const& = allocator_type());
      unordered_map(unordered_map const&);
      unordered_map(unordered_map &&);
      explicit unordered_map(Allocator const&);
      unordered_map(unordered_map const&, Allocator const&);
      ~unordered_map();
      unordered_map& operator=(unordered_map const&);
      unordered_map& operator=(unordered_map &&);
      allocator_type get_allocator() const;

      // size and capacity
      bool empty() const;
      size_type size() const;
      size_type max_size() const;

      // iterators
      iterator begin();
      const_iterator begin() const;
      iterator end();
      const_iterator end() const;
      const_iterator cbegin() const;
      const_iterator cend() const;

      // modifiers
      template<typename... Args> std::pair<iterator, bool> emplace(Args&&...);
      template<typename... Args> iterator emplace_hint(const_iterator, Args&&...);
      std::pair<iterator, bool> insert(value_type const&);
      iterator insert(const_iterator, value_type const&);
      template<typename InputIterator> void insert(InputIterator, InputIterator);
      iterator erase(const_iterator);
      size_type erase(key_type const&);
      iterator erase(const_iterator, const_iterator);
      void quick_erase(const_iterator);
      void erase_return_void(const_iterator);
      void clear();
      void swap(unordered_map&);

      // observers
      hasher hash_function() const;
      key_equal key_eq() const;

      // lookup
      iterator find(key_type const&);
      const_iterator find(key_type const&) const;
      template<typename CompatibleKey, typename CompatibleHash,
               typename CompatiblePredicate>
        iterator find(CompatibleKey const&, CompatibleHash const&,
                      CompatiblePredicate const&);
      template<typename CompatibleKey, typename CompatibleHash,
               typename CompatiblePredicate>
        const_iterator
        find(CompatibleKey const&, CompatibleHash const&,
             CompatiblePredicate const&) const;
      size_type count(key_type const&) const;
      std::pair<iterator, iterator> equal_range(key_type const&);
      std::pair<const_iterator, const_iterator> equal_range(key_type const&) const;
      mapped_type& operator[](key_type const&);
      Mapped& at(key_type const&);
      Mapped const& at(key_type const&) const;

      // bucket interface
      size_type bucket_count() const;
      size_type max_bucket_count() const;
      size_type bucket_size(size_type) const;
      size_type bucket(key_type const&) const;
      local_iterator begin(size_type);
      const_local_iterator begin(size_type) const;
      local_iterator end(size_type);
      const_local_iterator end(size_type) const;
      const_local_iterator cbegin(size_type) const;
      const_local_iterator cend(size_type);

      // hash policy
      float load_factor() const;
      float max_load_factor() const;
      void max_load_factor(float);
      void rehash(size_type);
    };

    // Equality Comparisons
    template<typename Key, typename Mapped, typename Hash, typename Pred,
             typename Alloc>
      bool operator==(unordered_map<Key, Mapped, Hash, Pred, Alloc> const&,
                      unordered_map<Key, Mapped, Hash, Pred, Alloc> const&);
    template<typename Key, typename Mapped, typename Hash, typename Pred,
             typename Alloc>
      bool operator!=(unordered_map<Key, Mapped, Hash, Pred, Alloc> const&,
                      unordered_map<Key, Mapped, Hash, Pred, Alloc> const&);

    // swap
    template<typename Key, typename Mapped, typename Hash, typename Pred,
             typename Alloc>
      void swap(unordered_map<Key, Mapped, Hash, Pred, Alloc>&,
                unordered_map<Key, Mapped, Hash, Pred, Alloc>&);

## Description

Template Parameters

Key | Key must be Assignable and CopyConstructible.
Mapped | Mapped must be CopyConstructible
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

1. typedef typename allocator_type::pointer pointer;

   `value_type*` if `allocator_type::pointer` is not defined.

2. typedef typename allocator_type::const_pointer const_pointer;

   `boost::pointer_to_other<pointer, value_type>::type` if `allocator_type::const_pointer` is not defined.

3. typedef implementation-defined size_type;

   An unsigned integral type.

   size_type can represent any non-negative value of difference_type.

4. typedef implementation-defined difference_type;

   A signed integral type.

   Is identical to the difference type of iterator and const_iterator.

5. typedef implementation-defined iterator;

   An iterator whose value type is value_type.

   The iterator category is at least a forward iterator.

   Convertible to const_iterator.

6. typedef implementation-defined const_iterator;

   A constant iterator whose value type is value_type.

   The iterator category is at least a forward iterator.

7. typedef implementation-defined local_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.

8. typedef implementation-defined const_local_iterator;

   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.

### `unordered_map` public construct/copy/destruct

1.     explicit unordered_map(size_type n = implementation-defined,
                              hasher const& hf = hasher(),
                              key_equal const& eq = key_equal(),
                              allocator_type const& a = allocator_type());

   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`

2.     template<typename InputIterator>
         unordered_map(InputIterator f, InputIterator l,
                       size_type n = implementation-defined,
                       hasher const& hf = hasher(),
                       key_equal const& eq = key_equal(),
                       allocator_type const& a = allocator_type());

   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.

3.     unordered_map(unordered_map const&);

   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: | `value_type` is copy constructible

4.     unordered_map(unordered_map &&);

   The move constructor.

   Notes: | This is implemented using Boost.Move.
   Requires: | `value_type` is move constructible. On compilers without rvalue reference support the emulation does not support moving without calling `boost::move` if `value_type` is not copyable. So, for example, you can't return the container from a function.

5.     explicit unordered_map(Allocator const& a);

   Constructs an empty container, using allocator `a`.

6.     unordered_map(unordered_map const& x, Allocator const& a);

   Constructs an container, copying `x`'s contained elements, hash function, predicate, maximum load factor, but using allocator `a`.

7.     ~unordered_map();

   Notes: | The destructor is applied to every element, and all memory is deallocated

    unordered_map& operator=(unordered_map const&);

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: | `value_type` is copy constructible

    unordered_map& operator=(unordered_map &&);

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: | `value_type` is move constructible.

    allocator_type get_allocator() const;

### `unordered_map` size and capacity

1.     bool empty() const;

   Returns: | `size() == 0`

2.     size_type size() const;

   Returns: | `std::distance(begin(), end())`

3.     size_type max_size() const;

   Returns: | `size()` of the largest possible container.

### `unordered_map` iterators

1.     iterator begin();
       const_iterator begin() const;

   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.

2.     iterator end();
       const_iterator end() const;

   Returns: | An iterator which refers to the past-the-end value for the container.

3.     const_iterator cbegin() const;

   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.

4.     const_iterator cend() const;

   Returns: | A constant iterator which refers to the past-the-end value for the container.

### `unordered_map` modifiers

1.     template<typename... Args> std::pair<iterator, bool> emplace(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.

   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 `hasher` the function has no effect.
   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 `std::pair` implementations don't support `std::piecewise_construct` this emulates it, but using `boost::unordered::piecewise_construct`. In version of Boost before 1.48 this emulated the variadic pair constructor from older C++0x drafts. For backwards compatability this can be enabled by defining the macro `BOOST_UNORDERED_DEPRECATED_PAIR_CONSTRUCT`.

2.     template<typename... Args>
         iterator emplace_hint(const_iterator hint, 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.

   `hint` is a suggestion to where the element should be inserted.

   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 `hasher` the function has no effect.
   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 `std::pair` implementations don't support `std::piecewise_construct` this emulates it, but using `boost::unordered::piecewise_construct`. In version of Boost before 1.48 this emulated the variadic pair constructor from older C++0x drafts. For backwards compatability this can be enabled by defining the macro `BOOST_UNORDERED_DEPRECATED_PAIR_CONSTRUCT`.

3.     std::pair<iterator, bool> insert(value_type const& obj);

   Inserts `obj` in the container if and only if there is no element in the container with an equivalent key.

   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 `hasher` the function has no effect.
   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.

4.     iterator insert(const_iterator hint, value_type const& 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.

   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 `hasher` the function has no effect.
   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.

5.     template<typename InputIterator>
         void insert(InputIterator first, InputIterator 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.

   Throws: | When inserting a single element, if an exception is thrown by an operation other than a call to `hasher` the function has no effect.
   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.

6.     iterator erase(const_iterator position);

   Erase the element pointed to by `position`.

   Returns: | The iterator following `position` before the erasure.
   Throws: | Only throws an exception if it is thrown by `hasher` or `key_equal`.
   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.

7.     size_type erase(key_type const& 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 `hasher` or `key_equal`.

8.     iterator erase(const_iterator first, const_iterator last);

   Erases the elements in the range from `first` to `last`.

   Returns: | The iterator following the erased elements - i.e. `last`.
   Throws: | Only throws an exception if it is thrown by `hasher` or `key_equal`. 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.

9.     void quick_erase(const_iterator position);

   Erase the element pointed to by `position`.

   Throws: | Only throws an exception if it is thrown by `hasher` or `key_equal`. 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 `erase` was expensive, but the container has been redesigned so that is no longer the case. So this method is now deprecated.

10.     void erase_return_void(const_iterator position);

    Erase the element pointed to by `position`.

    Throws: | Only throws an exception if it is thrown by `hasher` or `key_equal`. 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 `erase` was expensive, but the container has been redesigned so that is no longer the case. So this method is now deprecated.

11.     void clear();

    Erases all elements in the container.

    Postconditions: | `size() == 0`
    Throws: | Never throws an exception.

12.     void swap(unordered_map&);

    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 `key_equal` or `hasher`.
    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.

### `unordered_map` observers

1.     hasher hash_function() const;

   Returns: | The container's hash function.

2.     key_equal key_eq() const;

   Returns: | The container's key equality predicate.

### `unordered_map` lookup

1.     iterator find(key_type const& k);
       const_iterator find(key_type const& k) const;
       template<typename CompatibleKey, typename CompatibleHash,
                typename CompatiblePredicate>
         iterator find(CompatibleKey const& k, CompatibleHash const& hash,
                       CompatiblePredicate const& eq);
       template<typename CompatibleKey, typename CompatibleHash,
                typename CompatiblePredicate>
         const_iterator
         find(CompatibleKey const& k, CompatibleHash const& hash,
              CompatiblePredicate const& eq) const;

   Returns: | An iterator pointing to an element with key equivalent to `k`, or `b.end()` if no such element exists.
   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.

2.     size_type count(key_type const& k) const;

   Returns: | The number of elements with key equivalent to `k`.

3.     std::pair<iterator, iterator> equal_range(key_type const& k);
       std::pair<const_iterator, const_iterator> equal_range(key_type const& k) const;

   Returns: | A range containing all elements with key equivalent to `k`. If the container doesn't container any such elements, returns `std::make_pair(b.end(),b.end())`.

4.     mapped_type& operator[](key_type const& k);

   Effects: | If the container does not already contain an elements with a key equivalent to `k`, inserts the value `std::pair<key_type const, mapped_type>(k, mapped_type())`
   Returns: | A reference to `x.second` where x is the element already in the container, or the newly inserted element with a key equivalent to `k`
   Throws: | If an exception is thrown by an operation other than a call to `hasher` the function has no effect.
   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.

5.     Mapped& at(key_type const& k);
       Mapped const& at(key_type const& k) const;

   Returns: | A reference to `x.second` where `x` is the (unique) element whose key is equivalent to `k`.
   Throws: | An exception object of type `std::out_of_range` if no such element is present.

### `unordered_map` bucket interface

1.     size_type bucket_count() const;

   Returns: | The number of buckets.

2.     size_type max_bucket_count() const;

   Returns: | An upper bound on the number of buckets.

3.     size_type bucket_size(size_type n) const;

   Requires: | `n < bucket_count()`
   Returns: | The number of elements in bucket `n`.

4.     size_type bucket(key_type const& k) const;

   Returns: | The index of the bucket which would contain an element with key `k`.
   Postconditions: | The return value is less than `bucket_count()`

5.     local_iterator begin(size_type n);
       const_local_iterator begin(size_type n) const;

   Requires: | `n` shall be in the range `[0, bucket_count())`.
   Returns: | A local iterator pointing the first element in the bucket with index `n`.

6.     local_iterator end(size_type n);
       const_local_iterator end(size_type n) const;

   Requires: | `n` shall be in the range `[0, bucket_count())`.
   Returns: | A local iterator pointing the 'one past the end' element in the bucket with index `n`.

7.     const_local_iterator cbegin(size_type n) const;

   Requires: | `n` shall be in the range `[0, bucket_count())`.
   Returns: | A constant local iterator pointing the first element in the bucket with index `n`.

8.     const_local_iterator cend(size_type n);

   Requires: | `n` shall be in the range `[0, bucket_count())`.
   Returns: | A constant local iterator pointing the 'one past the end' element in the bucket with index `n`.

### `unordered_map` hash policy

1.     float load_factor() const;

   Returns: | The average number of elements per bucket.

2.     float max_load_factor() const;

   Returns: | Returns the current maximum load factor.

3.     void max_load_factor(float z);

   Effects: | Changes the container's maximum load factor, using `z` as a hint.

4.     void rehash(size_type 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.

### `unordered_map` Equality Comparisons

1.     template<typename Key, typename Mapped, typename Hash, typename Pred,
                typename Alloc>
         bool operator==(unordered_map<Key, Mapped, Hash, Pred, Alloc> const& x,
                         unordered_map<Key, Mapped, Hash, Pred, Alloc> const& 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. If you wish to use the old behaviour, define the macro `BOOST_UNORDERED_DEPRECATED_EQUALITY`. Behavior is undefined if the two containers don't have equivalent equality predicates.

2.     template<typename Key, typename Mapped, typename Hash, typename Pred,
                typename Alloc>
         bool operator!=(unordered_map<Key, Mapped, Hash, Pred, Alloc> const& x,
                         unordered_map<Key, Mapped, Hash, Pred, Alloc> const& 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. If you wish to use the old behaviour, define the macro `BOOST_UNORDERED_DEPRECATED_EQUALITY`. Behavior is undefined if the two containers don't have equivalent equality predicates.

### `unordered_map` swap

1.     template<typename Key, typename Mapped, typename Hash, typename Pred,
                typename Alloc>
         void swap(unordered_map<Key, Mapped, Hash, Pred, Alloc>& x,
                   unordered_map<Key, Mapped, Hash, Pred, Alloc>& 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: | `x.swap(y)`
   Throws: | Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of `key_equal` or `hasher`.
   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.