A C++ template library for embedded applications
Designed and maintained by
Aster Consulting Ltd

map / multimap

A fixed capacity map.
Uses std::less as the default key comparison method.
STL equivalent: std::map / std::multimap

This page just describes etl::map.

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

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

Member types

key_type                TKey
mapped_type             TMapped
value_type              std::pair<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::map<Tkey, TMapped, SIZE, TKeyCompare>();

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

Element access

TMapped& at(size_t i)
const TMapped& at(size_t i) const
Returns a reference or const reference to the indexed element. Emits an etl::map_out_of_range if the key is not in the
table.

TMapped& operator[](size_t i)
const TMapped& operator[](size_t i) const
Returns a reference or const reference to the indexed element.

iterator find (const key_type& k);
const_iterator find (const key_type& k) const;
Searches the container for an element with a key equivalent to k and returns an iterator to it if found, otherwise it returns
an iterator to etl::map::end()

size_type count (const key_type& k) const;
Count elements with a specific key.
Searches the container for elements with a key equivalent to k and returns the number of matches

iterator lower_bound (const key_type& k);
const_iterator lower_bound (const key_type& k) const;
Returns the iterator to the lower bound.
Returns an iterator pointing to the first element in the container whose key is not considered to go before k (i.e., either it
is equivalent or goes after).

iterator upper_bound (const key_type& k);
const_iterator upper_bound (const key_type& k) const;
Return the iterator to the upper bound.
Returns an iterator pointing to the first element in the container whose key is considered to go after k.

pair<const_iterator,const_iterator> equal_range (const key_type& k) const;
pair<iterator,iterator> equal_range (const key_type& k);
Get the range of equal elements.
Returns the bounds of a range that includes all the elements in the container which have a key equivalent to k.

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 rbegin()
const_iterator rbegin() const
const_iterator crbegin() const
Returns a reverse iterator to the beginning 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 map is SIZE, otherwise false.

size_t size() const
Returns the size of the map.

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

template <typename TIterator>
void insert(TIterator begin, TIterator end);
iterator insert(mapped_parameter_t value);
Inserts values in to the map. If the map is full then emits an etl::map_full error.

template <typename TIterator>
iterator erase(TIterator begin, TIterator end);
iterator erase(TIterator element);
Erases values in the map.

void clear();
Clears the map to a size of zero.

Non-member functions

==  true if the contents of the maps are equal, otherwise false.
!=  true if the contents of the maps are not equal, otherwise false.
map.h / multimap.h