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>
6.5 KiB
| title | weight |
|---|---|
| array | 1 |
{{< callout >}}
Header: array.h
Since: All versions
Similar to: std::array
{{< /callout >}}
A fixed capacity array.
Adds additional members functions, assign, insert & erase.
etl::array<typename T, const size_t SIZE>
See also:
[array_view]({{< relref "array-view" >}})
[multi_array]({{< relref "multi-array" >}})
Template deduction guides
C++17 and above
template <typename... T>
etl::array(T...)
Example
etl::array data{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 };
Defines data as an array of 'int', of length '10', containing the supplied data.
Make template
C++11 and above
template <typename T, typename... TValues>
constexpr auto make_array(TValues&&... values)
Example
auto data = etl::make_array<int>(0, 1, 2, 3, 4, 5, 6, 7, 8, 9);
Member types
value_type
size_type
difference_type
reference
const_reference
pointer
const_pointer
iterator
const_iterator
reverse_iterator
const_reverse_iterator
etl::array iterators are random access.
Static Constants
SIZE
Description
The size of the array.
Constructor
etl::array<int, 10> data = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 };
Description
Default or copy constructs each element.
Can be initialised like a C array.
Element access
T& at(size_t i)
const T& at(size_t i) const
Description
Returns a reference or const reference to the indexed element. Emits an etl::array_out_of_range if the index is not in range.
If asserts or exceptions are not enabled then an out of range index results in undefined behaviour.
T& operator[](size_t i)
const T& operator[](size_t i) const
Description
Returns a reference or const reference to the indexed element.
An out of range index results in undefined behaviour.
T& front()
const T& front() const
Description
Returns a reference or const reference to the first element.
T& back()
const T& back() const
Description
Returns a reference or const reference to the last element.
Iterators
iterator begin()
const_iterator begin() const
const_iterator cbegin() const
Description
Returns an iterator to the beginning of the array.
iterator end()
const_iterator end() const
const_iterator cend() const
Description
Returns an iterator to the end of the array.
iterator rbegin()
const_iterator rbegin() const
const_iterator crbegin() const
Description
Returns a reverse iterator to the beginning of the array.
iterator rend()
const_iterator rend() const
const_iterator crend() const
Description
Returns a reverse iterator to the end of the array.
Capacity
bool empty() const
Description
Returns true if the size of the array is zero, otherwise false.
size_t size() const
Description
Returns the size of the array.
size_t max_size() const
Description
Returns the maximum possible size of the array.
Modifiers
void fill(T value)
Description
Fills the array with value.
ETL Extensions
template <typename TIterator>
void assign(TIterator first, const TIterator last)
template <typename TIterator>
void assign(TIterator first, const TIterator last, parameter_t value)
Description
Assigns a range of values to the array. The second form set uninitialised elements to value.
If the range is larger than the array then the extra data is ignored.
If the range is smaller than the array then the unused array elements are left unmodified.
iterator insert_at(size_t position, parameter_t value)
iterator insert(const_iterator position, parameter_t value)
Description
Inserts a value into the array at the specified position, shifting elements to make room.
Elements may be truncated if they are shifted off the end of the array.
template <typename TIterator>
iterator insert_at(size_t position, TIterator first, const TIterator last)
Description
position is not checked for validity.
template <typename TIterator>
iterator insert(const_iterator position, TIterator first, const TIterator last)
Description
Inserts a range of values into the array at the specified position, shifting elements to make room.
Elements may be truncated if they are shifted off the end of the array.
The range may be larger than the capacity of the array. Excess elements will be ignored.
iterator erase_at(size_t position)
iterator erase_at(size_t position, parameter_t value)
iterator erase(const_iterator position)
iterator erase(const_iterator position, parameter_t value)
Description
Erases an element at the specified position, shifting elements into the space.
The value parameter variants initialise the unused elements with value, while the others leave them unchanged.
position is not checked for valid range.
iterator erase_range(size_t first, size_t last)
iterator erase_range(size_t first, size_t last, parameter_t value)
iterator erase(const_iterator first, const_iterator last)
iterator erase(const_iterator first, const_iterator last, parameter_t value)
Description
Erases a range, shifting elements into the space.
The value parameter variants initialise the unused elements with value, while the others leave them unchanged.
first/last are not checked for valid range.
Non-member functions
Lexicographically comparisons
operator ==
Description
true if the contents of the lists are equal, otherwise false.
operator !=
Description
true if the contents of the lists are not equal, otherwise false.
operator <
Description
true if the contents of the lhs are lexicographically less than the contents of the rhs, otherwise false.
operator <=
Description
true if the contents of the lhs are lexicographically less than or equal to the contents of the rhs, otherwise false.
operator >
Description
true if the contents of the lhs are lexicographically greater than the contents of the rhs, otherwise false.
operator >=
Description
true if the contents of the lhs are lexicographically greater than or equal to the contents of the rhs, otherwise false.