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>
7.1 KiB
| title |
|---|
| const_set / const_set_ext |
{{< callout >}}
Header: const_set.h
Similar to: std::set
{{< /callout >}}
A fixed capacity read-only set based on a sorted array.
The containers are designed to be able to be constexpr for C++14 and up.
Uses etl::less as the default key comparison method.
Internal storage
etl::const_set<typename TKey, size_t Size, TKeyCompare = etl::less>
Enternal storage
etl::const_set_ext<typename TKey, TKeyCompare = etl::less>
Inherits from etl::iconst_set<TKey, TMapped, TKeyCompare>.
etl::iconst_set may be used as a Size independent pointer or reference type for any etl::const_set or etl::const_set_ext instance.
Both the key type must be default constructible.
Template deduction guides
C++17 and above.
const_set
template <typename... TElements>
etl::const_set(TElements...)
Example
constexpr etl::const_set data{ 0, 1, 2, 3 };
Defines data as an const_set of int, of length 4, containing the supplied data.
const_set_ext
template <typename... TElements>
etl::const_set_ext(TElements...)
Example
constexpr etl::pair<int, int> values{ 0, 1, 2, 3 };
constexpr etl::const_set_ext data{ values };
Defines data as an const_set of int, of length 4, containing the supplied data.
constexpr values[]{ 0, 1, 2, 3 };
constexpr etl::span<int, 4> span{ values };
constexpr etl::const_set_ext data{ span };
Defines data as an const_set of int of length 4, containing the supplied data.
Member types
key_type TKey Must be default constructible.
value_type key_type
size_type std::size_t
difference_type std::ptrdiff_t
const_reference const T&
const_pointer const T*
const_iterator Constant random access iterator
Constructors
const_set
template <typename... TElements>
ETL_CONSTEXPR14 explicit const_set(TElements&&... elements) ETL_NOEXCEPT
Description
Construct a const_set from a variadic list of elements.
Static asserts if the elements are not of type value_type.
Static asserts if the number of elements is greater than the capacity of the const_set.
const_set_ext
ETL_CONSTEXPR14 const_set_ext() ETL_NOEXCEPT
Description
Default construct a const_set.
template <size_type Size>
ETL_CONSTEXPR14 explicit const_set_ext(const etl::span<const value_type, Size>& sp) ETL_NOEXCEPT
Description
Construct a const_set from a variadic list of elements.
template <size_type Size>
ETL_CONSTEXPR14 explicit const_set_ext(const value_type (&begin_)[Size]) ETL_NOEXCEPT
Description
Construct a const_set from an array.
Iterators
const_iterator begin() const ETL_NOEXCEPT
const_iterator cbegin() const ETL_NOEXCEPT
Description
Returns an iterator to the beginning of the set.
const_iterator end() const ETL_NOEXCEPT
const_iterator cend() const ETL_NOEXCEPT
Description
Returns an iterator to the end of the set.
Capacity
ETL_CONSTEXPR14 bool empty() const ETL_NOEXCEPT
Description
Returns true if the size of the set is zero, otherwise false.
ETL_CONSTEXPR14 bool full() const ETL_NOEXCEPT
Description
Returns true if the size of the lookup is size, otherwise false.
ETL_CONSTEXPR14 size_t size() const ETL_NOEXCEPT
Description
Returns the size of the lookup.
ETL_CONSTEXPR14 size_t max_size() const ETL_NOEXCEPT
Description
Returns the maximum possible size of the set.
Status
ETL_CONSTEXPR14 bool is_valid() const ETL_NOEXCEPT
Check that the elements are valid for a set.
The elements must be sorted and contain no duplicates.
Search
ETL_CONSTEXPR14 const_iterator find(const key_type& key) const ETL_NOEXCEPT
Description
Find the key in the container.
Return
A const_iterator to the element, or end() if it could not be found.
ETL_CONSTEXPR14 const_iterator lower_bound(const key_type& key) const ETL_NOEXCEPT
Description
Searches for the first element after the key.
Return
A const_iterator to the element, or end() if it could not be found.
ETL_CONSTEXPR14 const_iterator upper_bound(const key_type& key) const ETL_NOEXCEPT
Description
Searches for the first element with the key.
Return
A const_iterator to the element, or end() if it could not be found.
ETL_CONSTEXPR14 pair<const_iterator, const_iterator> equal_range(const key_type& key) const ETL_NOEXCEPT
Description
The return type is either std::pair (default) or etl::pair (ETL_NO_STL)
Return
Returns a range containing all elements equivalent to key.
ETL_CONSTEXPR14 bool contains(const key_type& k) const ETL_NOEXCEPT
Description
Check if the container contains the key.
Return
true if the container contains the key, otherwise false.
Search (transparent comparators)
template <typename K>
ETL_CONSTEXPR14 const_iterator find(const K& key) const ETL_NOEXCEPT
Description
Find the key in the container.
Return
A const_iterator to the element, or end() if it could not be found.
template <typename K>
ETL_CONSTEXPR14 const_iterator lower_bound(const K& key) const ETL_NOEXCEPT
Description
Searches for the first element after the key.
Return
A const_iterator to the element, or end() if it could not be found.
template <typename K>
ETL_CONSTEXPR14 const_iterator upper_bound(const K& key) const ETL_NOEXCEPT
Description
Searches for the first element with the key.
Return
A const_iterator to the element, or end() if it could not be found.
template <typename K>
ETL_CONSTEXPR14 pair<const_iterator, const_iterator> equal_range(const K& key) const ETL_NOEXCEPT
Description
The return type is either std::pair (default) or etl::pair (ETL_NO_STL)
Return
Returns a range containing all elements equivalent to key.
template <typename K>
ETL_CONSTEXPR14 bool contains(const K& k) const ETL_NOEXCEPT
Description
Check if the container contains the key.
Return
true if the container contains the key, otherwise false.
Non-member functions
Lexicographically comparisons
operator ==
true if the contents of the sets are equal, otherwise false.
operator !=
true if the contents of the sets are not equal, otherwise false.
operator <
true if the contents of the lhs is less-than the rhs, otherwise false.
operator <=
true if the contents of the lhs is less-than-equal the rhs, otherwise false.
operator >
true if the contents of the lhs is greater-than the rhs, otherwise false.
operator >=
true if the contents of the lhs is greater-than-equal the rhs, otherwise false.
Technical stuff
The const set is implemented as a sorted array key/value pairs.