| Home | Libraries | People | FAQ | More

## Class template flat_map

boost::container::flat_map

## Synopsis

    // In header: <boost/container/container_fwd.hpp>

    template<typename Key, typename T, typename Compare = std::less<Key>,
             typename Allocator = std::allocator<std::pair<Key, T> > >
    class flat_map {
    public:
      // construct/copy/destruct
      flat_map();
      explicit flat_map(const Compare &,
                        const allocator_type & = allocator_type());
      template<typename InputIterator>
        flat_map(InputIterator, InputIterator, const Compare & = Compare(),
                 const allocator_type & = allocator_type());
      template<typename InputIterator>
        flat_map(ordered_unique_range_t, InputIterator, InputIterator,
                 const Compare & = Compare(),
                 const allocator_type & = allocator_type());
      flat_map(const flat_map &);
      flat_map(flat_map &&);
      flat_map(const flat_map &, const allocator_type &);
      flat_map(flat_map &&, const allocator_type &);
      flat_map& operator=(const flat_map &);
      flat_map& operator=(flat_map &&);

      // public member functions
      allocator_type get_allocator() const;
      stored_allocator_type & get_stored_allocator();
      const stored_allocator_type & get_stored_allocator() const;
      iterator begin();
      const_iterator begin() const;
      iterator end();
      const_iterator end() const;
      reverse_iterator rbegin();
      const_reverse_iterator rbegin() const;
      reverse_iterator rend();
      const_reverse_iterator rend() const;
      const_iterator cbegin() const;
      const_iterator cend() const;
      const_reverse_iterator crbegin() const;
      const_reverse_iterator crend() const;
      bool empty() const;
      size_type size() const;
      size_type max_size() const;
      size_type capacity() const;
      void reserve(size_type);
      void shrink_to_fit();
      mapped_type & operator[](const key_type &);
      mapped_type & operator[](key_type &&);
      T & at(const key_type &);
      const T & at(const key_type &) const;
      template<class... Args> std::pair< iterator, bool > emplace(Args &&...);
      template<class... Args> iterator emplace_hint(const_iterator, Args &&...);
      std::pair< iterator, bool > insert(const value_type &);
      std::pair< iterator, bool > insert(value_type &&);
      std::pair< iterator, bool > insert(movable_value_type &&);
      iterator insert(const_iterator, const value_type &);
      iterator insert(const_iterator, value_type &&);
      iterator insert(const_iterator, movable_value_type &&);
      template<typename InputIterator> void insert(InputIterator, InputIterator);
      template<typename InputIterator>
        void insert(ordered_unique_range_t, InputIterator, InputIterator);
      iterator erase(const_iterator);
      size_type erase(const key_type &);
      iterator erase(const_iterator, const_iterator);
      void swap(flat_map &);
      void clear();
      key_compare key_comp() const;
      value_compare value_comp() const;
      iterator find(const key_type &);
      const_iterator find(const key_type &) const;
      size_type count(const key_type &) const;
      iterator lower_bound(const key_type &);
      const_iterator lower_bound(const key_type &) const;
      iterator upper_bound(const key_type &);
      const_iterator upper_bound(const key_type &) const;
      std::pair< iterator, iterator > equal_range(const key_type &);
      std::pair< const_iterator, const_iterator >
      equal_range(const key_type &) const;
    };

## Description

A flat_map is a kind of associative container that supports unique keys (contains at most one of each key value) and provides for fast retrieval of values of another type T based on the keys. The flat_map class supports random-access iterators.

A flat_map satisfies all of the requirements of a container and of a reversible container and of an associative container. A flat_map also provides most operations described for unique keys. For a flat_map<Key,T> the key_type is Key and the value_type is std::pair<Key,T> (unlike std::map<Key, T> which value_type is std::pair<const Key, T>).

Compare is the ordering function for Keys (e.g. std::less<Key>).

Allocator is the allocator to allocate the value_types (e.g. allocator< std::pair<Key, T> >).

flat_map is similar to std::map but it's implemented like an ordered vector. This means that inserting a new element into a flat_map invalidates previous iterators and references

Erasing an element of a flat_map invalidates iterators and references pointing to elements that come after (their keys are bigger) the erased element.

### `flat_map` public construct/copy/destruct

1.     flat_map();

   Effects: Default constructs an empty `flat_map`.

   Complexity: Constant.

2.     explicit flat_map(const Compare & comp,
                         const allocator_type & a = allocator_type());

   Effects: Constructs an empty `flat_map` using the specified comparison object and allocator.

   Complexity: Constant.

3.     template<typename InputIterator>
         flat_map(InputIterator first, InputIterator last,
                  const Compare & comp = Compare(),
                  const allocator_type & a = allocator_type());

   Effects: Constructs an empty `flat_map` using the specified comparison object and allocator, and inserts elements from the range [first ,last ).

   Complexity: Linear in N if the range [first ,last ) is already sorted using comp and otherwise N logN, where N is last - first.

4.     template<typename InputIterator>
         flat_map(ordered_unique_range_t, InputIterator first, InputIterator last,
                  const Compare & comp = Compare(),
                  const allocator_type & a = allocator_type());

   Effects: Constructs an empty `flat_map` using the specified comparison object and allocator, and inserts elements from the ordered unique range [first ,last). This function is more efficient than the normal range creation for ordered ranges.

   Requires: [first ,last) must be ordered according to the predicate and must be unique values.

   Complexity: Linear in N.

   Note: Non-standard extension.

5.     flat_map(const flat_map & x);

   Effects: Copy constructs a `flat_map`.

   Complexity: Linear in x.size().

6.     flat_map(flat_map && x);

   Effects: Move constructs a `flat_map`. Constructs *this using x's resources.

   Complexity: Constant.

   Postcondition: x is emptied.

7.     flat_map(const flat_map & x, const allocator_type & a);

   Effects: Copy constructs a `flat_map` using the specified allocator.

   Complexity: Linear in x.size().

8.     flat_map(flat_map && x, const allocator_type & a);

   Effects: Move constructs a `flat_map` using the specified allocator. Constructs *this using x's resources.

   Complexity: Constant if x.get_allocator() == a, linear otherwise.

9.     flat_map& operator=(const flat_map & x);

   Effects: Makes *this a copy of x.

   Complexity: Linear in x.size().

10.     flat_map& operator=(flat_map && mx);

    Effects: Move constructs a `flat_map`. Constructs *this using x's resources.

    Complexity: Construct.

    Postcondition: x is emptied.

### `flat_map` public member functions

1.     allocator_type get_allocator() const;

   Effects: Returns a copy of the Allocator that was passed to the object's constructor.

   Complexity: Constant.

2.     stored_allocator_type & get_stored_allocator();

   Effects: Returns a reference to the internal allocator.

   Throws: Nothing

   Complexity: Constant.

   Note: Non-standard extension.

3.     const stored_allocator_type & get_stored_allocator() const;

   Effects: Returns a reference to the internal allocator.

   Throws: Nothing

   Complexity: Constant.

   Note: Non-standard extension.

4.     iterator begin();

   Effects: Returns an iterator to the first element contained in the container.

   Throws: Nothing.

   Complexity: Constant.

5.     const_iterator begin() const;

   Effects: Returns a const_iterator to the first element contained in the container.

   Throws: Nothing.

   Complexity: Constant.

6.     iterator end();

   Effects: Returns an iterator to the end of the container.

   Throws: Nothing.

   Complexity: Constant.

7.     const_iterator end() const;

   Effects: Returns a const_iterator to the end of the container.

   Throws: Nothing.

   Complexity: Constant.

8.     reverse_iterator rbegin();

   Effects: Returns a reverse_iterator pointing to the beginning of the reversed container.

   Throws: Nothing.

   Complexity: Constant.

9.     const_reverse_iterator rbegin() const;

   Effects: Returns a const_reverse_iterator pointing to the beginning of the reversed container.

   Throws: Nothing.

   Complexity: Constant.

10.     reverse_iterator rend();

    Effects: Returns a reverse_iterator pointing to the end of the reversed container.

    Throws: Nothing.

    Complexity: Constant.

11.     const_reverse_iterator rend() const;

    Effects: Returns a const_reverse_iterator pointing to the end of the reversed container.

    Throws: Nothing.

    Complexity: Constant.

12.     const_iterator cbegin() const;

    Effects: Returns a const_iterator to the first element contained in the container.

    Throws: Nothing.

    Complexity: Constant.

13.     const_iterator cend() const;

    Effects: Returns a const_iterator to the end of the container.

    Throws: Nothing.

    Complexity: Constant.

14.     const_reverse_iterator crbegin() const;

    Effects: Returns a const_reverse_iterator pointing to the beginning of the reversed container.

    Throws: Nothing.

    Complexity: Constant.

15.     const_reverse_iterator crend() const;

    Effects: Returns a const_reverse_iterator pointing to the end of the reversed container.

    Throws: Nothing.

    Complexity: Constant.

16.     bool empty() const;

    Effects: Returns true if the container contains no elements.

    Throws: Nothing.

    Complexity: Constant.

17.     size_type size() const;

    Effects: Returns the number of the elements contained in the container.

    Throws: Nothing.

    Complexity: Constant.

18.     size_type max_size() const;

    Effects: Returns the largest possible size of the container.

    Throws: Nothing.

    Complexity: Constant.

19.     size_type capacity() const;

    Effects: Number of elements for which memory has been allocated. capacity() is always greater than or equal to size().

    Throws: Nothing.

    Complexity: Constant.

20.     void reserve(size_type cnt);

    Effects: If n is less than or equal to capacity(), this call has no effect. Otherwise, it is a request for allocation of additional memory. If the request is successful, then capacity() is greater than or equal to n; otherwise, capacity() is unchanged. In either case, size() is unchanged.

    Throws: If memory allocation allocation throws or T's copy constructor throws.

    Note: If capacity() is less than "cnt", iterators and references to to values might be invalidated.

21.     void shrink_to_fit();

    Effects: Tries to deallocate the excess of memory created

    Throws: If memory allocation throws, or T's copy constructor throws.

    Complexity: Linear to size().

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

    Effects: If there is no key equivalent to x in the `flat_map`, inserts value_type(x, T()) into the `flat_map`.

    Returns: Allocator reference to the mapped_type corresponding to x in *this.

    Complexity: Logarithmic.

23.     mapped_type & operator[](key_type && k);

    Effects: If there is no key equivalent to x in the `flat_map`, inserts value_type(move(x), T()) into the `flat_map` (the key is move-constructed)

    Returns: Allocator reference to the mapped_type corresponding to x in *this.

    Complexity: Logarithmic.

24.     T & at(const key_type & k);

    Returns: Allocator reference to the element whose key is equivalent to x.

    Throws: An exception object of type out_of_range if no such element is present.

    Complexity: logarithmic.

25.     const T & at(const key_type & k) const;

    Returns: Allocator reference to the element whose key is equivalent to x.

    Throws: An exception object of type out_of_range if no such element is present.

    Complexity: logarithmic.

26.     template<class... Args> std::pair< iterator, bool > emplace(Args &&... args);

    Effects: Inserts an object x of type T constructed with std::forward<Args>(args)... if and only if there is no element in the container with key equivalent to the key of x.

    Returns: The bool component of the returned pair is true if and only if the insertion takes place, and the iterator component of the pair points to the element with key equivalent to the key of x.

    Complexity: Logarithmic search time plus linear insertion to the elements with bigger keys than x.

    Note: If an element is inserted it might invalidate elements.

27.     template<class... Args>
          iterator emplace_hint(const_iterator hint, Args &&... args);

    Effects: Inserts an object of type T constructed with std::forward<Args>(args)... in the container if and only if there is no element in the container with key equivalent to the key of x. p is a hint pointing to where the insert should start to search.

    Returns: An iterator pointing to the element with key equivalent to the key of x.

    Complexity: Logarithmic search time (constant if x is inserted right before p) plus insertion linear to the elements with bigger keys than x.

    Note: If an element is inserted it might invalidate elements.

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

    Effects: Inserts x if and only if there is no element in the container with key equivalent to the key of x.

    Returns: The bool component of the returned pair is true if and only if the insertion takes place, and the iterator component of the pair points to the element with key equivalent to the key of x.

    Complexity: Logarithmic search time plus linear insertion to the elements with bigger keys than x.

    Note: If an element is inserted it might invalidate elements.

29.     std::pair< iterator, bool > insert(value_type && x);

    Effects: Inserts a new value_type move constructed from the pair if and only if there is no element in the container with key equivalent to the key of x.

    Returns: The bool component of the returned pair is true if and only if the insertion takes place, and the iterator component of the pair points to the element with key equivalent to the key of x.

    Complexity: Logarithmic search time plus linear insertion to the elements with bigger keys than x.

    Note: If an element is inserted it might invalidate elements.

30.     std::pair< iterator, bool > insert(movable_value_type && x);

    Effects: Inserts a new value_type move constructed from the pair if and only if there is no element in the container with key equivalent to the key of x.

    Returns: The bool component of the returned pair is true if and only if the insertion takes place, and the iterator component of the pair points to the element with key equivalent to the key of x.

    Complexity: Logarithmic search time plus linear insertion to the elements with bigger keys than x.

    Note: If an element is inserted it might invalidate elements.

31.     iterator insert(const_iterator position, const value_type & x);

    Effects: Inserts a copy of x in the container if and only if there is no element in the container with key equivalent to the key of x. p is a hint pointing to where the insert should start to search.

    Returns: An iterator pointing to the element with key equivalent to the key of x.

    Complexity: Logarithmic search time (constant if x is inserted right before p) plus insertion linear to the elements with bigger keys than x.

    Note: If an element is inserted it might invalidate elements.

32.     iterator insert(const_iterator position, value_type && x);

    Effects: Inserts an element move constructed from x in the container. p is a hint pointing to where the insert should start to search.

    Returns: An iterator pointing to the element with key equivalent to the key of x.

    Complexity: Logarithmic search time (constant if x is inserted right before p) plus insertion linear to the elements with bigger keys than x.

    Note: If an element is inserted it might invalidate elements.

33.     iterator insert(const_iterator position, movable_value_type && x);

    Effects: Inserts an element move constructed from x in the container. p is a hint pointing to where the insert should start to search.

    Returns: An iterator pointing to the element with key equivalent to the key of x.

    Complexity: Logarithmic search time (constant if x is inserted right before p) plus insertion linear to the elements with bigger keys than x.

    Note: If an element is inserted it might invalidate elements.

34.     template<typename InputIterator>
          void insert(InputIterator first, InputIterator last);

    Requires: first, last are not iterators into *this.

    Effects: inserts each element from the range [first,last) if and only if there is no element with key equivalent to the key of that element.

    Complexity: At most N log(size()+N) (N is the distance from first to last) search time plus N*size() insertion time.

    Note: If an element is inserted it might invalidate elements.

35.     template<typename InputIterator>
          void insert(ordered_unique_range_t, InputIterator first, InputIterator last);

    Requires: first, last are not iterators into *this.

    Requires: [first ,last) must be ordered according to the predicate and must be unique values.

    Effects: inserts each element from the range [first,last) if and only if there is no element with key equivalent to the key of that element. This function is more efficient than the normal range creation for ordered ranges.

    Complexity: At most N log(size()+N) (N is the distance from first to last) search time plus N*size() insertion time.

    Note: If an element is inserted it might invalidate elements.

36.     iterator erase(const_iterator position);

    Effects: Erases the element pointed to by position.

    Returns: Returns an iterator pointing to the element immediately following q prior to the element being erased. If no such element exists, returns end().

    Complexity: Linear to the elements with keys bigger than position

    Note: Invalidates elements with keys not less than the erased element.

37.     size_type erase(const key_type & x);

    Effects: Erases all elements in the container with key equivalent to x.

    Returns: Returns the number of erased elements.

    Complexity: Logarithmic search time plus erasure time linear to the elements with bigger keys.

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

    Effects: Erases all the elements in the range [first, last).

    Returns: Returns last.

    Complexity: size()*N where N is the distance from first to last.

    Complexity: Logarithmic search time plus erasure time linear to the elements with bigger keys.

39.     void swap(flat_map & x);

    Effects: Swaps the contents of *this and x.

    Throws: Nothing.

    Complexity: Constant.

40.     void clear();

    Effects: erase(a.begin(),a.end()).

    Postcondition: size() == 0.

    Complexity: linear in size().

41.     key_compare key_comp() const;

    Effects: Returns the comparison object out of which a was constructed.

    Complexity: Constant.

42.     value_compare value_comp() const;

    Effects: Returns an object of value_compare constructed out of the comparison object.

    Complexity: Constant.

43.     iterator find(const key_type & x);

    Returns: An iterator pointing to an element with the key equivalent to x, or end() if such an element is not found.

    Complexity: Logarithmic.

44.     const_iterator find(const key_type & x) const;

    Returns: Allocator const_iterator pointing to an element with the key equivalent to x, or end() if such an element is not found.

    Complexity: Logarithmic.s

45.     size_type count(const key_type & x) const;

    Returns: The number of elements with key equivalent to x.

    Complexity: log(size())+count(k)

46.     iterator lower_bound(const key_type & x);

    Returns: An iterator pointing to the first element with key not less than k, or a.end() if such an element is not found.

    Complexity: Logarithmic

47.     const_iterator lower_bound(const key_type & x) const;

    Returns: Allocator const iterator pointing to the first element with key not less than k, or a.end() if such an element is not found.

    Complexity: Logarithmic

48.     iterator upper_bound(const key_type & x);

    Returns: An iterator pointing to the first element with key not less than x, or end() if such an element is not found.

    Complexity: Logarithmic

49.     const_iterator upper_bound(const key_type & x) const;

    Returns: Allocator const iterator pointing to the first element with key not less than x, or end() if such an element is not found.

    Complexity: Logarithmic

50.     std::pair< iterator, iterator > equal_range(const key_type & x);

    Effects: Equivalent to std::make_pair(this->lower_bound(k), this->upper_bound(k)).

    Complexity: Logarithmic

51.     std::pair< const_iterator, const_iterator >
        equal_range(const key_type & x) const;

    Effects: Equivalent to std::make_pair(this->lower_bound(k), this->upper_bound(k)).

    Complexity: Logarithmic