A C++ template library for embedded applications
Designed and maintained by
Aster Consulting Ltd
Join the ETL community

array


A fixed capacity array.
STL equivalent: std::array
Adds additional members functions, assign, insert & erase.

etl::array<typename T, const size_t SIZE>

See also

array_view

____________________________________________________________________________________________________

Member types


value_type              T
size_type               std::size_t
difference_type         std::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        std::reverse_iterator<iterator>
const_reverse_iterator  std::reverse_iterator<const_iterator>
____________________________________________________________________________________________________

Constructor


Default or copy constructs each element.
Can be initialised like a C array.

etl::array<int, 10> data = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 };
____________________________________________________________________________________________________

Element access


T& at(size_t i)
const T& at(size_t i) const

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

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

Returns a reference or const reference to the first element.
____________________________________________________________________________________________________

T& back()
const T& back() const

Returns a reference or const reference to the last element.
____________________________________________________________________________________________________

Iterators


iterator begin()
const_iterator begin() const
const_iterator cbegin() const

Returns an iterator to the beginning of the array.
____________________________________________________________________________________________________

iterator end()
const_iterator end() const
const_iterator cend() const

Returns an iterator to the end of the array.
____________________________________________________________________________________________________

iterator rbegin()
const_iterator rbegin() const
const_iterator crbegin() const

Returns a reverse iterator to the beginning of the array.
____________________________________________________________________________________________________

iterator rend()
const_iterator rend() const
const_iterator crend() const

Returns a reverse iterator to the end of the array.
____________________________________________________________________________________________________

Capacity


bool empty() const

Returns true if the size of the array is zero, otherwise false.
____________________________________________________________________________________________________

size_t size() const

Returns the size of the array.
____________________________________________________________________________________________________

size_t max_size() const

Returns the maximum possible size of the array.
____________________________________________________________________________________________________

Modifiers


void fill(T value)

Fills the array with value.
____________________________________________________________________________________________________

template <typename TIterator>
void assign(TIterator first, const TIterator last)

template <typename TIterator>
void assign(TIterator first, const TIterator last, parameter_t value)

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)

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)

position is not checked for validity.
____________________________________________________________________________________________________

template <typename TIterator>
iterator insert(const_iterator position, TIterator first, const TIterator last)

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)

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)

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

== true if the contents of the arrays are equal, otherwise false.
!= true if the contents of the arrays are not equal, otherwise false.
true if the contents of the lhs are lexicographically less than the contents of the rhs,  otherwise false.
<= true if the contents of the lhs are lexicographically less than or equal to the contents of the rhs, otherwise false.
true if the contents of the lhs are lexicographically greater than the contents of the rhs,  otherwise false.
>= true if the contents of the lhs are lexicographically greater than or equal to the contents of the rhs, otherwise false.
array.h