mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-16 00:46:03 +08:00
* 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>
190 lines
3.9 KiB
Markdown
190 lines
3.9 KiB
Markdown
---
|
|
title: "multi_span"
|
|
---
|
|
|
|
{{< callout >}}
|
|
Header: `multi_span.h`
|
|
{{< /callout >}}
|
|
|
|
This class implements a span of a range of spans.
|
|
Allows implementation of Scatter/Gather to multiple buffers or ports.
|
|
Iterating through the `multi_span` will iterate through the collection of spans consecutively.
|
|
The list of spans must be in a contiguous list, such as an array or vector.
|
|
|
|
```cpp
|
|
etl::multi_span<typename T>
|
|
```
|
|
Where `T` is the element type of the spans.
|
|
|
|
## Member types
|
|
|
|
```cpp
|
|
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 Forward iterator <20.39.5
|
|
Bidirectional iterator >=20.39.5
|
|
const_iterator Constant Forward iterator <20.39.5
|
|
Constant bidirectional iterator >=20.39.5
|
|
reverse_iterator ETL_OR_STD::reverse_iterator<iterator>
|
|
const_reverse_iterator ETL_OR_STD::reverse_iterator<const_iterator>
|
|
|
|
span_type etl::span<T>
|
|
span_list_type etl::span<const span_type>
|
|
```
|
|
|
|
## Constructors
|
|
|
|
ETL_CONSTEXPR multi_span(span_list_type span_list)
|
|
**Description**
|
|
Construct from a span of spans.
|
|
|
|
---
|
|
|
|
template <typename TContainer>
|
|
ETL_CONSTEXPR multi_span(TContainer& a) ETL_NOEXCEPT
|
|
**Description**
|
|
Construct from a container of spans.
|
|
|
|
---
|
|
|
|
template <typename TContainer>
|
|
ETL_CONSTEXPR multi_span(const TContainer& a) ETL_NOEXCEPT
|
|
**Description**
|
|
Construct from a const container of spans.
|
|
|
|
---
|
|
|
|
template <typename TIterator>
|
|
ETL_CONSTEXPR multi_span(TIterator begin, TIterator end)
|
|
**Description**
|
|
Construct from a range of spans.
|
|
|
|
---
|
|
|
|
template <typename TIterator>
|
|
ETL_CONSTEXPR multi_span(TIterator begin, size_t length)
|
|
**Description**
|
|
Construct from a range of spans.
|
|
|
|
---
|
|
|
|
ETL_CONSTEXPR multi_span(const multi_span& other)
|
|
**Description**
|
|
Copy constructor.
|
|
|
|
## Access
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14 multi_span& operator =(const multi_span& other) ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Assign from a other `multi_span`.
|
|
|
|
## Iterators
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR iterator begin() const ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Returns an iterator to the beginning of the span.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR iterator end() const ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Returns an iterator to the end of the span.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR iterator cbegin() const ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Returns a const iterator to the beginning of the span.
|
|
From: `20.39.5`
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR iterator cend() const ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Returns a const iterator to the end of the span.
|
|
From: `20.39.5`
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR iterator rbegin() const ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Returns a reverse iterator to the beginning of the span.
|
|
From: `20.39.5`
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR iterator rend() const ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Returns a reverse iterator to the end of the span.
|
|
From: `20.39.5`
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR iterator crbegin() const ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Returns a const reverse iterator to the beginning of the span.
|
|
From: `20.39.5`
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR iterator crend() const ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Returns a const reverse iterator to the end of the span.
|
|
From: `20.39.5`
|
|
|
|
## Capacity
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR bool empty() const ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Returns true if the size of the multi_span is zero, otherwise false.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR size_t size() const ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Returns the size of the multi_span.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR size_t size_bytes() const ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Returns the size of the multi_span in bytes.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR size_t size_spans() const ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Returns the number of the spans.
|