Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

PrevUpHomeNext

Class template flat_map

boost::container::flat_map

Synopsis

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

template<typename Key, typename T, typename Compare = std::less<Key>, 
         typename Allocator = new_allocator< std::pair< Key, T> > > 
class flat_map {
public:
  // types
  typedef Key                                                              key_type;              
  typedef T                                                                mapped_type;           
  typedef std::pair< Key, T >                                              value_type;            
  typedef ::boost::container::allocator_traits< Allocator >                allocator_traits_type; 
  typedef boost::container::allocator_traits< Allocator >::pointer         pointer;               
  typedef boost::container::allocator_traits< Allocator >::const_pointer   const_pointer;         
  typedef boost::container::allocator_traits< Allocator >::reference       reference;             
  typedef boost::container::allocator_traits< Allocator >::const_reference const_reference;       
  typedef boost::container::allocator_traits< Allocator >::size_type       size_type;             
  typedef boost::container::allocator_traits< Allocator >::difference_type difference_type;       
  typedef Allocator                                                        allocator_type;        
  typedef implementation_defined                                           stored_allocator_type; 
  typedef implementation_defined                                           value_compare;         
  typedef Compare                                                          key_compare;           
  typedef implementation_defined                                           iterator;              
  typedef implementation_defined                                           const_iterator;        
  typedef implementation_defined                                           reverse_iterator;      
  typedef implementation_defined                                           const_reverse_iterator;
  typedef implementation_defined                                           movable_value_type;    

  // construct/copy/destruct
  flat_map() noexcept(container_detail::is_nothrow_default_constructible< Allocator >::value &&container_detail::is_nothrow_default_constructible< Compare >::value));
  explicit flat_map(const Compare &, 
                    const allocator_type & = allocator_type());
  explicit flat_map(const allocator_type &);
  template<typename InputIterator> 
    flat_map(InputIterator, InputIterator, const Compare & = Compare(), 
             const allocator_type & = allocator_type());
  template<typename InputIterator> 
    flat_map(InputIterator, InputIterator, const allocator_type &);
  template<typename InputIterator> 
    flat_map(ordered_unique_range_t, InputIterator, InputIterator, 
             const Compare & = Compare(), 
             const allocator_type & = allocator_type());
  flat_map(std::initializer_list< value_type >, const Compare & = Compare(), 
           const allocator_type & = allocator_type());
  flat_map(std::initializer_list< value_type >, const allocator_type &);
  flat_map(ordered_unique_range_t, std::initializer_list< value_type >, 
           const Compare & = Compare(), 
           const allocator_type & = allocator_type());
  flat_map(const flat_map &);
  flat_map(flat_map &&) noexcept(boost::container::container_detail::is_nothrow_move_constructible< Compare >::value));
  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 &&) noexcept((allocator_traits_type::propagate_on_container_move_assignment::value||allocator_traits_type::is_always_equal::value)&&boost::container::container_detail::is_nothrow_move_assignable< Compare >::value));
  flat_map & operator=(std::initializer_list< value_type >);

  // public member functions
  allocator_type get_allocator() const noexcept;
  stored_allocator_type & get_stored_allocator() noexcept;
  const stored_allocator_type & get_stored_allocator() const noexcept;
  iterator begin() noexcept;
  const_iterator begin() const noexcept;
  iterator end() noexcept;
  const_iterator end() const noexcept;
  reverse_iterator rbegin() noexcept;
  const_reverse_iterator rbegin() const noexcept;
  reverse_iterator rend() noexcept;
  const_reverse_iterator rend() const noexcept;
  const_iterator cbegin() const noexcept;
  const_iterator cend() const noexcept;
  const_reverse_iterator crbegin() const noexcept;
  const_reverse_iterator crend() const noexcept;
  bool empty() const noexcept;
  size_type size() const noexcept;
  size_type max_size() const noexcept;
  size_type capacity() const noexcept;
  void reserve(size_type);
  void shrink_to_fit();
  mapped_type & operator[](const key_type &);
  mapped_type & operator[](key_type &&);
  template<typename M> 
    std::pair< iterator, bool > insert_or_assign(const key_type &, M &&);
  template<typename M> 
    std::pair< iterator, bool > insert_or_assign(key_type &&, M &&);
  template<typename M> 
    iterator insert_or_assign(const_iterator, const key_type &, M &&);
  template<typename M> 
    iterator insert_or_assign(const_iterator, key_type &&, M &&);
  iterator nth(size_type) noexcept;
  const_iterator nth(size_type) const noexcept;
  size_type index_of(iterator) noexcept;
  size_type index_of(const_iterator) const noexcept;
  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 &&...);
  template<class... Args> 
    std::pair< iterator, bool > try_emplace(const key_type &, Args &&...);
  template<class... Args> 
    iterator try_emplace(const_iterator, const key_type &, Args &&...);
  template<class... Args> 
    std::pair< iterator, bool > try_emplace(key_type &&, Args &&...);
  template<class... Args> 
    iterator try_emplace(const_iterator, key_type &&, 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);
  void insert(std::initializer_list< value_type >);
  void insert(ordered_unique_range_t, std::initializer_list< value_type >);
  template<typename C2> void merge(flat_map< Key, T, C2, Allocator > &);
  template<typename C2> void merge(flat_map< Key, T, C2, Allocator > &&);
  template<typename C2> void merge(flat_multimap< Key, T, C2, Allocator > &);
  template<typename C2> void merge(flat_multimap< Key, T, C2, Allocator > &&);
  iterator erase(const_iterator);
  size_type erase(const key_type &);
  iterator erase(const_iterator, const_iterator);
  void swap(flat_map &) noexcept(allocator_traits_type::is_always_equal::value &&boost::container::container_detail::is_nothrow_swappable< Compare >::value));
  void clear() noexcept;
  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;

  // friend functions
  friend bool operator==(const flat_map &, const flat_map &);
  friend bool operator!=(const flat_map &, const flat_map &);
  friend bool operator<(const flat_map &, const flat_map &);
  friend bool operator>(const flat_map &, const flat_map &);
  friend bool operator<=(const flat_map &, const flat_map &);
  friend bool operator>=(const flat_map &, const flat_map &);
  friend void swap(flat_map &, flat_map &);
};

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 invalidates iterators and references pointing to elements that come after (their keys are bigger) the erased element.

This container provides random-access iterators.

Template Parameters

  1. typename Key

    is the key_type of the map

  2. typename T
  3. typename Compare = std::less<Key>

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

  4. typename Allocator = new_allocator< std::pair< Key, T> >

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

flat_map public construct/copy/destruct

  1. flat_map() noexcept(container_detail::is_nothrow_default_constructible< Allocator >::value &&container_detail::is_nothrow_default_constructible< Compare >::value));

    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. explicit flat_map(const allocator_type & a);

    Effects: Constructs an empty flat_map using the specified allocator.

    Complexity: Constant.

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

  5. template<typename InputIterator> 
      flat_map(InputIterator first, InputIterator last, const allocator_type & a);

    Effects: Constructs an empty flat_map using the specified 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.

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

  7. flat_map(std::initializer_list< value_type > il, 
             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 [il.begin() ,il.end()).

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

  8. flat_map(std::initializer_list< value_type > il, const allocator_type & a);

    Effects: Constructs an empty flat_map using the specified allocator, and inserts elements from the range [il.begin() ,il.end()).

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

  9. flat_map(ordered_unique_range_t, std::initializer_list< value_type > il, 
             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 [il.begin(), il.end()). This function is more efficient than the normal range creation for ordered ranges.

    Requires: [il.begin(), il.end()) must be ordered according to the predicate and must be unique values.

    Complexity: Linear in N.

    Note: Non-standard extension.

  10. flat_map(const flat_map & x);

    Effects: Copy constructs a flat_map.

    Complexity: Linear in x.size().

  11. flat_map(flat_map && x) noexcept(boost::container::container_detail::is_nothrow_move_constructible< Compare >::value));

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

    Complexity: Constant.

    Postcondition: x is emptied.

  12. 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().

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

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

    Effects: Makes *this a copy of x.

    Complexity: Linear in x.size().

  15. flat_map & operator=(flat_map && x) noexcept((allocator_traits_type::propagate_on_container_move_assignment::value||allocator_traits_type::is_always_equal::value)&&boost::container::container_detail::is_nothrow_move_assignable< Compare >::value));

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

    Throws: If allocator_traits_type::propagate_on_container_move_assignment is false and (allocation throws or value_type's move constructor throws)

    Complexity: Constant if allocator_traits_type:: propagate_on_container_move_assignment is true or this->get>allocator() == x.get_allocator(). Linear otherwise.

  16. flat_map & operator=(std::initializer_list< value_type > il);
    Effects: Assign elements from il to *this

flat_map public member functions

  1. allocator_type get_allocator() const noexcept;

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

    Complexity: Constant.

  2. stored_allocator_type & get_stored_allocator() noexcept;

    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 noexcept;

    Effects: Returns a reference to the internal allocator.

    Throws: Nothing

    Complexity: Constant.

    Note: Non-standard extension.

  4. iterator begin() noexcept;

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

    Throws: Nothing.

    Complexity: Constant.

  5. const_iterator begin() const noexcept;

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

    Throws: Nothing.

    Complexity: Constant.

  6. iterator end() noexcept;

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

    Throws: Nothing.

    Complexity: Constant.

  7. const_iterator end() const noexcept;

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

    Throws: Nothing.

    Complexity: Constant.

  8. reverse_iterator rbegin() noexcept;

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

    Throws: Nothing.

    Complexity: Constant.

  9. const_reverse_iterator rbegin() const noexcept;

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

    Throws: Nothing.

    Complexity: Constant.

  10. reverse_iterator rend() noexcept;

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

    Throws: Nothing.

    Complexity: Constant.

  11. const_reverse_iterator rend() const noexcept;

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

    Throws: Nothing.

    Complexity: Constant.

  12. const_iterator cbegin() const noexcept;

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

    Throws: Nothing.

    Complexity: Constant.

  13. const_iterator cend() const noexcept;

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

    Throws: Nothing.

    Complexity: Constant.

  14. const_reverse_iterator crbegin() const noexcept;

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

    Throws: Nothing.

    Complexity: Constant.

  15. const_reverse_iterator crend() const noexcept;

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

    Throws: Nothing.

    Complexity: Constant.

  16. bool empty() const noexcept;

    Effects: Returns true if the container contains no elements.

    Throws: Nothing.

    Complexity: Constant.

  17. size_type size() const noexcept;

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

    Throws: Nothing.

    Complexity: Constant.

  18. size_type max_size() const noexcept;

    Effects: Returns the largest possible size of the container.

    Throws: Nothing.

    Complexity: Constant.

  19. size_type capacity() const noexcept;

    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: A 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: A reference to the mapped_type corresponding to x in *this.

    Complexity: Logarithmic.

  24. template<typename M> 
      std::pair< iterator, bool > insert_or_assign(const key_type & k, M && obj);

    Effects: If a key equivalent to k already exists in the container, assigns forward<M>(obj) to the mapped_type corresponding to the key k. If the key does not exist, inserts the new value as if by insert, constructing it from value_type(k, forward<M>(obj)).

    No iterators or references are invalidated. If the insertion is successful, pointers and references to the element obtained while it is held in the node handle are invalidated, and pointers and references obtained to that element before it was extracted become valid.

    Returns: The bool component is true if the insertion took place and false if the assignment took place. The iterator component is pointing at the element that was inserted or updated.

    Complexity: Logarithmic in the size of the container.

  25. template<typename M> 
      std::pair< iterator, bool > insert_or_assign(key_type && k, M && obj);

    Effects: If a key equivalent to k already exists in the container, assigns forward<M>(obj) to the mapped_type corresponding to the key k. If the key does not exist, inserts the new value as if by insert, constructing it from value_type(k, move(obj)).

    No iterators or references are invalidated. If the insertion is successful, pointers and references to the element obtained while it is held in the node handle are invalidated, and pointers and references obtained to that element before it was extracted become valid.

    Returns: The bool component is true if the insertion took place and false if the assignment took place. The iterator component is pointing at the element that was inserted or updated.

    Complexity: Logarithmic in the size of the container.

  26. template<typename M> 
      iterator insert_or_assign(const_iterator hint, const key_type & k, M && obj);

    Effects: If a key equivalent to k already exists in the container, assigns forward<M>(obj) to the mapped_type corresponding to the key k. If the key does not exist, inserts the new value as if by insert, constructing it from value_type(k, forward<M>(obj)) and the new element to the container as close as possible to the position just before hint.

    No iterators or references are invalidated. If the insertion is successful, pointers and references to the element obtained while it is held in the node handle are invalidated, and pointers and references obtained to that element before it was extracted become valid.

    Returns: The bool component is true if the insertion took place and false if the assignment took place. The iterator component is pointing at the element that was inserted or updated.

    Complexity: Logarithmic in the size of the container in general, but amortized constant if the new element is inserted just before hint.

  27. template<typename M> 
      iterator insert_or_assign(const_iterator hint, key_type && k, M && obj);

    Effects: If a key equivalent to k already exists in the container, assigns forward<M>(obj) to the mapped_type corresponding to the key k. If the key does not exist, inserts the new value as if by insert, constructing it from value_type(k, move(obj)) and the new element to the container as close as possible to the position just before hint.

    No iterators or references are invalidated. If the insertion is successful, pointers and references to the element obtained while it is held in the node handle are invalidated, and pointers and references obtained to that element before it was extracted become valid.

    Returns: The bool component is true if the insertion took place and false if the assignment took place. The iterator component is pointing at the element that was inserted or updated.

    Complexity: Logarithmic in the size of the container in general, but amortized constant if the new element is inserted just before hint.

  28. iterator nth(size_type n) noexcept;

    Requires: size() >= n.

    Effects: Returns an iterator to the nth element from the beginning of the container. Returns end() if n == size().

    Throws: Nothing.

    Complexity: Constant.

    Note: Non-standard extension

  29. const_iterator nth(size_type n) const noexcept;

    Requires: size() >= n.

    Effects: Returns a const_iterator to the nth element from the beginning of the container. Returns end() if n == size().

    Throws: Nothing.

    Complexity: Constant.

    Note: Non-standard extension

  30. size_type index_of(iterator p) noexcept;

    Requires: begin() <= p <= end().

    Effects: Returns the index of the element pointed by p and size() if p == end().

    Throws: Nothing.

    Complexity: Constant.

    Note: Non-standard extension

  31. size_type index_of(const_iterator p) const noexcept;

    Requires: begin() <= p <= end().

    Effects: Returns the index of the element pointed by p and size() if p == end().

    Throws: Nothing.

    Complexity: Constant.

    Note: Non-standard extension

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

    Returns: A 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.

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

    Returns: A 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.

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

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

  36. template<class... Args> 
      std::pair< iterator, bool > try_emplace(const key_type & k, Args &&... args);

    Requires: value_type shall be EmplaceConstructible into map from piecewise_construct, forward_as_tuple(k), forward_as_tuple(forward<Args>(args)...).

    Effects: If the map already contains an element whose key is equivalent to k, there is no effect. Otherwise inserts an object of type value_type constructed with piecewise_construct, forward_as_tuple(k), forward_as_tuple(forward<Args>(args)...).

    Returns: The bool component of the returned pair is true if and only if the insertion took place. The returned iterator points to the map element whose key is equivalent to k.

    Complexity: Logarithmic.

  37. template<class... Args> 
      iterator try_emplace(const_iterator hint, const key_type & k, 
                           Args &&... args);

    Requires: value_type shall be EmplaceConstructible into map from piecewise_construct, forward_as_tuple(k), forward_as_tuple(forward<Args>(args)...).

    Effects: If the map already contains an element whose key is equivalent to k, there is no effect. Otherwise inserts an object of type value_type constructed with piecewise_construct, forward_as_tuple(k), forward_as_tuple(forward<Args>(args)...).

    Returns: The returned iterator points to the map element whose key is equivalent to k.

    Complexity: Logarithmic in general, but amortized constant if value is inserted right before p.

  38. template<class... Args> 
      std::pair< iterator, bool > try_emplace(key_type && k, Args &&... args);

    Requires: value_type shall be EmplaceConstructible into map from piecewise_construct, forward_as_tuple(move(k)), forward_as_tuple(forward<Args>(args)...).

    Effects: If the map already contains an element whose key is equivalent to k, there is no effect. Otherwise inserts an object of type value_type constructed with piecewise_construct, forward_as_tuple(move(k)), forward_as_tuple(forward<Args>(args)...).

    Returns: The bool component of the returned pair is true if and only if the insertion took place. The returned iterator points to the map element whose key is equivalent to k.

    Complexity: Logarithmic.

  39. template<class... Args> 
      iterator try_emplace(const_iterator hint, key_type && k, Args &&... args);

    Requires: value_type shall be EmplaceConstructible into map from piecewise_construct, forward_as_tuple(move(k)), forward_as_tuple(forward<Args>(args)...).

    Effects: If the map already contains an element whose key is equivalent to k, there is no effect. Otherwise inserts an object of type value_type constructed with piecewise_construct, forward_as_tuple(move(k)), forward_as_tuple(forward<Args>(args)...).

    Returns: The returned iterator points to the map element whose key is equivalent to k.

    Complexity: Logarithmic in general, but amortized constant if value is inserted right before p.

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

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

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

  43. iterator insert(const_iterator p, 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.

  44. iterator insert(const_iterator p, 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.

  45. iterator insert(const_iterator p, 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.

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

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

    Note: Non-standard extension.

  48. void insert(std::initializer_list< value_type > il);

    Effects: inserts each element from the range [il.begin(), il.end()) 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 il.first() to il.end()) search time plus N*size() insertion time.

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

  49. void insert(ordered_unique_range_t, std::initializer_list< value_type > il);

    Requires: [il.begin(), il.end()) must be ordered according to the predicate and must be unique values.

    Effects: inserts each element from the range [il.begin(), il.end()) 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.

    Note: Non-standard extension.

  50. template<typename C2> void merge(flat_map< Key, T, C2, Allocator > & source);

    Requires: this->get_allocator() == source.get_allocator().

    Effects: Attempts to extract each element in source and insert it into a using the comparison object of *this. If there is an element in a with key equivalent to the key of an element from source, then that element is not extracted from source.

    Postcondition: Pointers and references to the transferred elements of source refer to those same elements but as members of *this. Iterators referring to the transferred elements will continue to refer to their elements, but they now behave as iterators into *this, not into source.

    Throws: Nothing unless the comparison object throws.

    Complexity: N log(a.size() + N) (N has the value source.size())

  51. template<typename C2> void merge(flat_map< Key, T, C2, Allocator > && source);

    Requires: this->get_allocator() == source.get_allocator().

    Effects: Attempts to extract each element in source and insert it into a using the comparison object of *this. If there is an element in a with key equivalent to the key of an element from source, then that element is not extracted from source.

    Postcondition: Pointers and references to the transferred elements of source refer to those same elements but as members of *this. Iterators referring to the transferred elements will continue to refer to their elements, but they now behave as iterators into *this, not into source.

    Throws: Nothing unless the comparison object throws.

    Complexity: N log(a.size() + N) (N has the value source.size())

  52. template<typename C2> 
      void merge(flat_multimap< Key, T, C2, Allocator > & source);

    Requires: this->get_allocator() == source.get_allocator().

    Effects: Attempts to extract each element in source and insert it into a using the comparison object of *this. If there is an element in a with key equivalent to the key of an element from source, then that element is not extracted from source.

    Postcondition: Pointers and references to the transferred elements of source refer to those same elements but as members of *this. Iterators referring to the transferred elements will continue to refer to their elements, but they now behave as iterators into *this, not into source.

    Throws: Nothing unless the comparison object throws.

    Complexity: N log(a.size() + N) (N has the value source.size())

  53. template<typename C2> 
      void merge(flat_multimap< Key, T, C2, Allocator > && source);

    Requires: this->get_allocator() == source.get_allocator().

    Effects: Attempts to extract each element in source and insert it into a using the comparison object of *this. If there is an element in a with key equivalent to the key of an element from source, then that element is not extracted from source.

    Postcondition: Pointers and references to the transferred elements of source refer to those same elements but as members of *this. Iterators referring to the transferred elements will continue to refer to their elements, but they now behave as iterators into *this, not into source.

    Throws: Nothing unless the comparison object throws.

    Complexity: N log(a.size() + N) (N has the value source.size())

  54. iterator erase(const_iterator p);

    Effects: Erases the element pointed to by p.

    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 p

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

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

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

  57. void swap(flat_map & x) noexcept(allocator_traits_type::is_always_equal::value &&boost::container::container_detail::is_nothrow_swappable< Compare >::value));

    Effects: Swaps the contents of *this and x.

    Throws: Nothing.

    Complexity: Constant.

  58. void clear() noexcept;

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

    Postcondition: size() == 0.

    Complexity: linear in size().

  59. key_compare key_comp() const;

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

    Complexity: Constant.

  60. value_compare value_comp() const;

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

    Complexity: Constant.

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

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

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

    Complexity: Logarithmic.

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

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

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

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

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

    Returns: A 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.

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

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

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

    Complexity: Logarithmic.

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

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

flat_map friend functions

  1. friend bool operator==(const flat_map & x, const flat_map & y);

    Effects: Returns true if x and y are equal

    Complexity: Linear to the number of elements in the container.

  2. friend bool operator!=(const flat_map & x, const flat_map & y);

    Effects: Returns true if x and y are unequal

    Complexity: Linear to the number of elements in the container.

  3. friend bool operator<(const flat_map & x, const flat_map & y);

    Effects: Returns true if x is less than y

    Complexity: Linear to the number of elements in the container.

  4. friend bool operator>(const flat_map & x, const flat_map & y);

    Effects: Returns true if x is greater than y

    Complexity: Linear to the number of elements in the container.

  5. friend bool operator<=(const flat_map & x, const flat_map & y);

    Effects: Returns true if x is equal or less than y

    Complexity: Linear to the number of elements in the container.

  6. friend bool operator>=(const flat_map & x, const flat_map & y);

    Effects: Returns true if x is equal or greater than y

    Complexity: Linear to the number of elements in the container.

  7. friend void swap(flat_map & x, flat_map & y);

    Effects: x.swap(y)

    Complexity: Constant.


PrevUpHomeNext