4a88884b39
* Add ranges * Initial Hugo setup * Work in progress * Added selection for local or remote site * Updated to 'light' theme * Changed to using Hextra Hugo theme * Changed to using Hextra Hugo theme * Changed to Hextra Hugo theme * Change to Hextra Hugo theme * Updated Hugo setup. * Updated Hugo setup. # Conflicts: # docs/releases/_index.md * Work in progress * Added new fonts Added new documentation * Latest documentation updates * Latest documentation updates # Conflicts: # docs/containers/array.md # docs/containers/array_view.md # docs/containers/array_wrapper.md # docs/containers/bip_buffer_spsc_atomic.md # docs/containers/bitset.md # docs/containers/indirect_vector.md # docs/containers/vector.md # docs/getting-started/compilers.md * Added bloom_filter markdown doc * Added more documentation Updated CSS for light and dark modes * Fixed some menus Added mode documentation files * Updated CSS rules Added badges to home page Added uniqur_ptr + pool tutorial * Fixed formatting on the home page markdown Modified light amd dark code formatting * Updated unique_ptr-with-pool * Added container and shared message tutorials * Updates to documentation * Added const_multimap * Updated source-formatting.md * Added initial raw text files form Web site editor * Innore coverage build directory * Exported raw text documentation files from the web site editor * Hugo updates * Added Hugo intalation and markdown descriptions * More addition to the documentation * Added closure.md and updates to delegate.md * Added format.md * Added documentation for etl::delegate_observable, etl::function, Base64 codec * Added io_port documentation * Added basic_format_spec * Added documentation for string_stream and string utilities. * Added more documentation Updated the documentation CSS * Added documentation for clocks, day, duration * Added more documentation for chrono classes Updated callouts * More chrono documentation * Completed chrono documentation * Maths functions documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Added multiple documentation files * Added iterator.md * Added debug_count.md and versions.md * Added debug_count.md and versions.md * Added more documentation * More documentation * Added some design pattern documentation Modified some of the layout files Modified the About documentation * Converted more documentation pages Modified the site CSS * Added more documentation Moced some documentation files to new directories * Added more documentation Tweaks to CSS * Added callback_timer_deferred_locked documentation * Added callback_timer_locked documentation * More documentation updates * More documentation updates * More documentation updates * New documentation files. Harmonised file name format * New documentation files. * Multiple document updates * Multiple document updates * Final conversion of web pages * Updates before PR * Updates before PR * Updates before PR # Conflicts: # docs/blog/_index.md * Final pre PR updates * Updates to message framework documentation * Renamed directory * Fix spelling * Added author and date to blog files Moved documentation files merged from development * Fixed 'Description' typo * Fix typos # Conflicts: # docs/IO/io_port.md # docs/containers/sets/const-multiset.md # docs/containers/sets/const-set.md # docs/maths/correlation.md # docs/maths/gamma.md * Renamed two files to lower case * Minor renaming * Added author and date * Updated callout on bresenham_line.md Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset. Updated the Python 'update_release.py' to copy 'version.txt' * Replace space in filename with hyphen. Added more information to hugo-commands.md * Replace space in filename with hyphen. Added more information to hugo-commands.md # Conflicts: # docs/getting-started/view-the-docs-locally/hugo-commands.md * Added a link to pseudo_moving_average.md * Updated title pages for groups * Fixed missing 404 for non-existent pages * Fixed coordinate variable names in the 'Calculating the intersection' example --------- Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>
9.2 KiB
| title |
|---|
| multimap |
{{< callout type="info">}}
Header: multimap.h
Similar to: std::multimap
{{< /callout >}}
A fixed capacity multimap.
Uses std::less as the default key comparison method.
etl::multimap<typename TKey, typename TMapped, const size_t SIZE, TKeyCompare = etl::less>
Inherits from etl::imap<TKey, TMapped, TKeyCompare>.
etl::imap may be used as a size independent pointer or reference type for any etl::multimap instance.
Template deduction guides
C++17 and above
template <typename... TPairs>
etl::multimap(TPairs...)
Example
etl::multimap data{ etl::pair{0, 1}, etl::pair{2, 3}, etl::pair{4, 5}, etl::pair{6, 7} }
Defines data as an multimap of int/int pairs, of length 4, containing the supplied data.
Make template
C++11 and above
template <typename TKey,
typename TMapped,
typename TKeyCompare = etl::less<TKey>,
typename... TPairs>
constexpr auto make_flat_map(TValues&&... values)
Example
auto data = etl::make_map<int. int>(etl::pair{0, 1}, etl::pair{2, 3},
etl::pair{4, 5}, etl::pair{6, 7});
Member types
key_type TKey
mapped_type TMapped
value_type etl or std::pair<key_type, mapped_type>
size_type size_t
difference_type 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 etl or std::reverse_iterator<iterator>
const_reverse_iterator etl or std::reverse_iterator<const_iterator>
Constructor
etl::multimap<Tkey, TMapped, SIZE, TKeyCompare>();
Description
Default constructor.
template <typename TIterator>
etl::multimap<Tkey, TMapped, SIZE, TKeyCompare>(TIterator begin, TIterator end);
Description
Construct from the range [begin, end).
Element access
TMapped& at(key_parameter_t key)
const TMapped& at(key_parameter_t key) const
Description
Returns a reference or const reference to the indexed element.
Asserts an etl::map_out_of_range if the key is not in the table.
If assert or exceptions are not enabled then undefined behaviour occurs.
TMapped& operator[](key_parameter_t key)
const TMapped& operator[](key_parameter_t key) const
Description
Returns a reference or const reference to the indexed element.
If the key does not exist then one is created using the default constructor.
If the multimap is full then asserts an etl::map_full. If asserts or exceptions are not enabled then undefined behaviour occurs.
iterator find(key_parameter_t key);
const_iterator find(key_parameter_t key) const
Description
Searches the container for an element with a key equivalent to key and returns an iterator to it if found, otherwise it returns an iterator to etl::multimap::end().
size_type count(key_parameter_t key) const
Description
Count elements with a specific key.
Searches the container for elements with a key equivalent to key and returns the number of matches
iterator lower_bound(key_parameter_t key);
const_iterator lower_bound(key_parameter_t key) const
Description
Returns an iterator pointing to the first element in the container whose key is not considered to go before key (i.e., either it is equivalent or goes after).
iterator upper_bound(key_parameter_t key);
const_iterator upper_bound(key_parameter_t key) const
Description
Returns an iterator pointing to the first element in the container whose key is considered to go after key.
pair<const_iterator, const_iterator> equal_range(key_parameter_t key) const
pair<iterator, iterator> equal_range(key_parameter_t key)
Description
Returns the bounds of a range that includes all the elements in the container which have a key equivalent to key.
The return type is either std::pair (default) or etl::pair (ETL_NO_STL)
For comparators that define is_transparent.
template <typename K>
iterator find(const K& key)
Description
Searches the container for an element with a key equivalent to key and returns an iterator to it if found, otherwise it returns an iterator to etl::multimap::end().
Since: 20.21.0
C++11 or above.
template <typename K>
const_iterator find(const K& key) const
Description
Searches the container for an element with a key equivalent to key and returns a const iterator to it if found, otherwise it returns a const iterator to etl::multimap::end().
template <typename K>
iterator lower_bound(const K& key)
Description
Returns an iterator pointing to the first element in the container whose key is not considered to go before key (i.e., either it is equivalent or goes after).
Since: 20.21.0
C++11 or above.
template <typename K>
const_iterator lower_bound(const K& key) const
Description
Returns a const iterator pointing to the first element in the container whose key is not considered to go before key (i.e., either it is equivalent or goes after).
Since: 20.21.0
C++11 or above.
template <typename K>
iterator upper_bound(const K& key)
Description
Returns an iterator pointing to the first element in the container whose key is considered to go after key.
Since: 20.21.0
C++11 or above.
template <typename K>
const_iterator upper_bound(const K& key) const
Description
Returns a const iterator pointing to the first element in the container whose key is considered to go after key.
Since: 20.21.0
C++11 or above.
template <typename K>
pair<iterator, iterator> equal_range(const K& key)
Description
Returns the bounds of a range that includes all the elements in the container which have a key equivalent to key.
The return type is either std::pair (default) or etl::pair (ETL_NO_STL)
Since: 20.21.0
C++11 or above.
template <typename K>
pair<const_iterator, const_iterator> equal_range(const K& key) const
Description
Returns the bounds of a range that includes all the elements in the container which have a key equivalent to key.
The return type is either std::pair (default) or etl::pair (ETL_NO_STL)
bool contains(key_value_parameter_t key) const
Description
Check if the container contains the key.
Since: 20.21.0
template <typename K>
bool contains(const K& k) const
Description
Check if the container contains the key.
Since: 20.21.0
C++11 or above.
For comparators that define is_transparent.
Iterators
iterator begin()
const_iterator begin() const
const_iterator cbegin() const
Description
Returns an iterator to the beginning of the multimap.
iterator end()
const_iterator end() const
const_iterator cend() const
Description
Returns an iterator to the end of the multimap.
iterator rbegin()
const_iterator rbegin() const
const_iterator crbegin() const
Description
Returns a reverse iterator to the beginning of the multimap.
iterator rend()
const_iterator rend() const
const_iterator crend() const
Description
Returns a reverse iterator to the end of the multimap.
Capacity
bool empty() const
Description
Returns true if the size of the multimap is zero, otherwise false.
bool full() const
Description
Returns true if the size of the multimap is SIZE, otherwise false.
size_t size() const
Description
Returns the size of the multimap.
size_t max_size() const
Description
Returns the maximum possible size of the multimap.
size_t available() const
Description
Returns the remaining available capacity in the multimap.
Modifiers
template <typename TIterator>
void insert(TIterator begin, TIterator end)
Description
Before: 20.20.0
template <typename TIterator>
iterator insert(TIterator begin, TIterator end)
Description
Since: 20.20.0
iterator insert(mapped_parameter_t value)
Description
Inserts values in to the multimap.
If the multimap is full then asserts an etl::map_full error. If asserts or exceptions are not enabled then undefined behaviour occurs.
template <typename TIterator>
iterator erase(TIterator begin, TIterator end)
Description
iterator erase(TIterator element)
Description
Erases values in the multimap.
Iterator are not checked for validity.
size_t erase(const key_type& key)
Description
20.21.0
template <typename K>
size_t erase(K&& key)
Description
void clear()
Description
Clears the multimap to a size of zero.
Non-member functions
operator ==
Description
true if the contents of the maps are equal, otherwise false.
operator !=
Description
true if the contents of the maps are not equal, otherwise false.