A C++ template library for embedded applications
Designed and maintained by
Aster Consulting Ltd
Join the ETL community

flat_map / flat_multmap


A fixed capacity map based on a sorted vector.
The container is an associative lookup table with O(N) insertion and erase, and O(log N) search.
This container is best used for tables that are occasionally updated and spend most of their time being searched.
The interface is most similar to std::map.
Uses std::less as the default key comparison method.

etl::flat_map<typename TKey, typename TMapped, const size_t SIZE, TKeyCompare = std::less>

Inherits from etl::iflat_map<TKey, TMapped, TKeyCompare>
etl::iflat_map may be used as a size independent pointer or reference type for any etl::flat_map instance.

____________________________________________________________________________________________________

Member types


key_type                TKey
mapped_type             TMapped
value_type              std::pair<const key_type, mapped_type>
size_type               std::size_t
difference_type         std::ptrdiff_t
reference               value_type&
const_reference         const value_type&
pointer                 value_type*
const_pointer           const value_type*
iterator                Random access iterator
const_iterator          Constant random access iterator
reverse_iterator        std::reverse_iterator<iterator>
const_reverse_iterator  std::reverse_iterator<const_iterator>

____________________________________________________________________________________________________

Constructor


etl::flat_map<Tkey, TMapped, SIZE, TKeyCompare>();

etl::flat_map(const flat_map& other)

template <typename TIterator>
etl::flat_map<Tkey, TMapped, SIZE, TKeyCompare>(TIterator begin, TIterator end);

____________________________________________________________________________________________________

Element access


TMapped& at(key_parameter_t key)
const TMapped& at(key_parameter_t key) const

Returns a reference or const reference to the indexed element.
Emits an etl::flat_map_out_of_range if the key is not in the table. If asserts or exceptions are not enabled then
undefined behaviour occurs.
____________________________________________________________________________________________________

TMapped& operator[](key_parameter_t key)
const TMapped& operator[](key_parameter_t key) const

Returns a reference or const reference to the indexed element.
If the key is not in the table then a new entry is created.

____________________________________________________________________________________________________

Iterators


iterator begin()
const_iterator begin() const
const_iterator cbegin() const

Returns an iterator to the beginning of the map.
____________________________________________________________________________________________________

iterator end()
const_iterator end() const
const_iterator cend() const

Returns an iterator to the end of the map.
____________________________________________________________________________________________________

iterator rbegin()
const_iterator rbegin() const
const_iterator crbegin() const

Returns a reverse iterator to the beginning of the map.
____________________________________________________________________________________________________

iterator rend()
const_iterator rend() const
const_iterator crend() const

Returns a reverse iterator to the end of the map.

____________________________________________________________________________________________________

Capacity


bool empty() const

Returns true if the size of the map is zero, otherwise false.
____________________________________________________________________________________________________

bool full() const

Returns true if the size of the lookup is SIZE, otherwise false.
____________________________________________________________________________________________________

size_t size() const

Returns the size of the lookup.
____________________________________________________________________________________________________

size_t max_size() const

Returns the maximum possible size of the map.
____________________________________________________________________________________________________

size_t available() const

Returns the remaining available capacity in the map.

____________________________________________________________________________________________________

Modifiers


flat_map& operator = (const flat_map& rhs)

Copies the data from another flat map.
____________________________________________________________________________________________________

std::pair<iterator, bool> insert(const value_type& value)
iterator insert(iterator position, const value_type& value)

template <class TIterator>
void insert(TIterator first, TIterator last)

Inserts values in to the map.
If the map is full then emits an etl::flat_map_full. If asserts or exceptions are not enabled then undefined behaviour
occurs.
____________________________________________________________________________________________________

std::pair<iterator, bool> emplace((const value_type& value))
std::pair<iterator, bool> emplace(const key_type& key, const mapped_type& value)

Inserts key/value pairs into the map by constructing directly into storage.
____________________________________________________________________________________________________

template <typename T1>
std::pair<iterator, bool> emplace(const key_type& key, const T1& value1)

template <typename T1, typename T2>
std::pair<iterator, bool> emplace(const key_type& key, const T1& value1, const T2& value2)

template <typename T1, typename T2, typename T3>
std::pair<iterator, bool> emplace(const key_type& key, const T1& value1, const T2& value2, const T3&
value3)

template <typename T1, typename T2, typename T3, typename T4>
std::pair<iterator, bool> emplace(const key_type& key, const T1& value1, const T2& value2, const T3&
value3, const T4& value4)

Inserts key/value pairs into the map by constructing directly into storage. The value is constructed from the set of 'value'
parameters.
The emplace function differ from that of std::map in that, due to C++03 not supporting 'perfect forwarding', the values
for constructing mapped types must be listed as parameters and not nested in a 'mapped' value parameter.
____________________________________________________________________________________________________

size_t erase(key_value_parameter_t key)
void erase(iterator i_element)
void erase(iterator first, iterator last)

Erases values in the map.
Iterator parameters are not checked for validity.
____________________________________________________________________________________________________

void clear();

Clears the lookup to a size of zero.

____________________________________________________________________________________________________

Search


iterator find(key_value_parameter_t key)
const_iterator find(key_value_parameter_t key) const

iterator lower_bound(key_value_parameter_t key)
const_iterator lower_bound(key_value_parameter_t key) const

iterator upper_bound(key_value_parameter_t key)
const_iterator upper_bound(key_value_parameter_t key) const

std::pair<iterator, iterator> equal_range(key_value_parameter_t key)
std::pair<const_iterator, const_iterator> equal_range(key_value_parameter_t key) const

____________________________________________________________________________________________________

Non-member functions


Lexicographically comparisons


==  true if the contents of the maps are equal, otherwise false.
!=  true if the contents of the maps are not equal, otherwise false.

____________________________________________________________________________________________________

Technical stuff


Flat maps are usually implemented internally as a sorted vector of key/value pairs. Whilst this makes searching fast, it can
have a detrimental effect when items are inserted into a container that stores complex, non-trivial keys or values.
As inserting requires that all of the items above the insert position must be shifted, this can become an expensive
operation for larger containers.

To improve insertion performance ETL flat maps are implemented as vectors of pointers to key/value pairs, sorted by key
value. An insertion will involve a copy of a range of pointers; an operation that can be made very fast.

The downside is that access to an item via an iterator will involve one indirection and the overhead of the container will be
one pointer per item. A normal flat map implementation does not have this overhead.
flat_map.h / flat_multimap.h