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.9 KiB
| title |
|---|
| poly_span |
{{< callout >}}
Header: poly_span.h
From: 20.31.0
{{< /callout >}}
Polymorphic span.
This class implements a view in to a contiguous range through a base type.
etl::poly_span<typename TBase, size_t Extent = etl::dynamic_extent>
Template deduction guides
C++17
template <typename TIterator>
poly_span(const TIterator begin, const TIterator end)
->poly_span<etl::remove_pointer_t<TIterator>, etl::dynamic_extent>;
template <typename TIterator, typename TSize>
poly_span(const TIterator begin, const TSize size)
->poly_span<etl::remove_pointer_t<TIterator>, etl::dynamic_extent>;
template <typename T, size_t N>
poly_span(T(&)[N])
-> poly_span<T, N>;
template <typename T, size_t N>
poly_span(etl::array<T, N>&)
-> poly_span<T, N>;
template <typename T, size_t N>
poly_span(const etl::array<T, N>&)
-> poly_span<const T, N>;
template <typename T, size_t N>
poly_span(std::array<T, N>&)
->poly_span<T, N>;
template <typename T, size_t N>
poly_span(const std::array<T, N>&)
->poly_span<const T, N>;
Member types
element_type T
value_type remove_cv<T>::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
reverse_iterator ETL_OR_STD::reverse_iterator<iterator>
Constructors
ETL_CONSTEXPR poly_span() ETL_NOEXCEPT
template <typename TIterator, typename TSize>
ETL_CONSTEXPR poly_span(const TIterator begin, const TSize size) ETL_NOEXCEPT
Description
Static asserts if etl::iterator_traits<TIterator>::iterator_category is not random_access_iterator_tag
or etl::iterator_traits<TIterator>::value_type is not the same as, or not derived from TBase.
template <typename TIterator>
ETL_CONSTEXPR poly_span(const TIterator begin, const TIterator end)
Description
Static asserts if etl::iterator_traits<TIterator>::iterator_category is not random_access_iterator_tag
or etl::iterator_traits<TIterator>::value_type is not the same as, or not derived from TBase.
template<typename U, size_t N>
ETL_CONSTEXPR poly_span(U(&begin_)[N]) ETL_NOEXCEPT
Description
Static asserts if N is greater than Extent or etl::iterator_traits<TIterator>::value_type is not the same as, or not derived from TBase.
template <typename U, size_t N>
ETL_CONSTEXPR poly_span(etl::array<U, N>& a) ETL_NOEXCEPT
Description
Static asserts if N is greater than Extent or etl::iterator_traits<TIterator>::value_type is not the same as, or not derived from TBase.
template <typename U, size_t N>
ETL_CONSTEXPR poly_span(const etl::array<U, N>& a) ETL_NOEXCEPT
Description
Static asserts if N is greater than Extent or etl::iterator_traits<TIterator>::value_type is not the same as, or not derived from TBase.
template <typename U, size_t N>
ETL_CONSTEXPR poly_span(std::array<U, N>& a) ETL_NOEXCEPT
Description
Enabled if ETL_USING_CPP11 and ETL_USING_STL are true.
Static asserts if N is greater than Extent or etl::iterator_traits<TIterator>::value_type is not the same as, or not derived from TBase.
template <typename U, size_t N>
ETL_CONSTEXPR poly_span(const std::array<U, N>& a) ETL_NOEXCEPT
Description
Enabled if ETL_USING_CPP11 and ETL_USING_STL are true.
Static asserts if N is greater than Extent or etl::iterator_traits<TIterator>::value_type is not the same as, or not derived from TBase.
ETL_CONSTEXPR poly_span(const poly_span& other)
Description
Copy constructor.
Access
ETL_CONSTEXPR reference operator[](size_t i) const
Description
Returns a reference to the indexed element.
Index out of range results in undefined behaviour.
ETL_NODISCARD ETL_CONSTEXPR reference front() const ETL_NOEXCEPT
Description
Returns a reference to the first element.
ETL_NODISCARD ETL_CONSTEXPR reference back() const ETL_NOEXCEPT
Description
Returns a reference to the last element.
ETL_NODISCARD ETL_CONSTEXPR pointer data() const ETL_NOEXCEPT
Description
Returns a pointer to the first element.
ETL_CONSTEXPR14 poly_span& operator =(const poly_span& other) ETL_NOEXCEPT
Description
Assign from a other span
template <typename UBase>
ETL_CONSTEXPR14 poly_span& operator =(const poly_span<UBase, Extent>& other) ETL_NOEXCEPT
Description
Assign from a other span.
template <size_t COUNT>
ETL_NODISCARD ETL_CONSTEXPR etl::poly_span<element_type, COUNT> first() const
Description
Returns a span consisting of the first COUNT elements of the current span.
ETL_NODISCARD ETL_CONSTEXPR etl::poly_span<element_type, etl::dynamic_extent> last(size_t count) const
Description
Returns a span consisting of the last count elements of the current span.
template <size_t COUNT>
ETL_NODISCARD ETL_CONSTEXPR etl::poly_span<element_type, COUNT> last() const
Description
Returns a span consisting of the last COUNT elements of the current span
ETL_NODISCARD ETL_CONSTEXPR etl::poly_span<element_type, etl::dynamic_extent> first(size_t count) const
Description
Returns a span consisting of the first count elements of the current span.
template <const size_t OFFSET, size_t COUNT = etl::dynamic_extent>
ETL_NODISCARD ETL_CONSTEXPR etl::poly_span<element_type, COUNT != etl::dynamic_extent ? COUNT : Extent - OFFSET> subspan() const
Description
Returns a subspan consisting of the range starting at OFFSET for COUNT elements of the current span.
ETL_NODISCARD ETL_CONSTEXPR etl::poly_span<element_type, etl::dynamic_extent> subspan(size_t offset, size_t count = etl::dynamic_extent) const
Description
Returns a subspan consisting of the range starting at offset for count elements of the current span.
Iterators
ETL_NODISCARD ETL_CONSTEXPR iterator begin() const ETL_NOEXCEPT
Description
Returns an iterator to the beginning of the span.
ETL_NODISCARD ETL_CONSTEXPR iterator end() const ETL_NOEXCEPT
Description
Returns an iterator to the end of the span.
ETL_NODISCARD ETL_CONSTEXPR iterator rbegin() const ETL_NOEXCEPT
Description
Returns a reverse iterator to the beginning of the span.
ETL_NODISCARD ETL_CONSTEXPR iterator rend() const ETL_NOEXCEPT
Description
Returns a reverse iterator to the end of the span.
Capacity
ETL_NODISCARD ETL_CONSTEXPR bool empty() const ETL_NOEXCEPT
Description
Returns true if the size of the span is zero, otherwise false.
ETL_NODISCARD ETL_CONSTEXPR size_t size() const ETL_NOEXCEPT
Description
Returns the size of the span.
ETL_NODISCARD ETL_CONSTEXPR size_t size_bytes() const ETL_NOEXCEPT
Description
Returns the size of the span in bytes.
ETL_NODISCARD ETL_CONSTEXPR size_t size_of_element() const ETL_NOEXCEPT
Description
Returns the size of the elements pointed to by the span, in bytes.
Non-member functions
Hash
There is a specialisation of etl::hash for etl::poly_span.
Example
struct Base
{
virtual ~Base() {}
virtual void Print() const = 0;
};
struct Derived : Base
{
Derived(int i_)
: i(i_)
{
}
void Print() const override
{
std::cout << "Derived " << i << "\n";
}
int i;
};
etl::array data{ Derived(1), Derived(2), Derived(3), Derived(4) };
etl::poly_span<Base> ps{ data };
for (const Base& b : ps)
{
b.Print();
}