Define a Amino array of elements of type T.
More...
#include <Array.h>
Public Types | |
| using | value_type = typename BaseClass::value_type |
The type of the value being stored in the array. Equivalent to T. More... | |
| using | pointer = typename BaseClass::pointer |
Type to represent a mutable pointer to an array element value. Equivalent to value_type*. More... | |
| using | const_pointer = typename BaseClass::const_pointer |
Type to represent a constant pointer to an array element value. Equivalent to value_type const*. More... | |
| using | reference = typename BaseClass::reference |
Type to represent a mutable reference to an array element value. Equivalent to value_type&. More... | |
| using | const_reference = typename BaseClass::const_reference |
Type to represent a constant reference to an array element value. Equivalent to value_type const&. More... | |
| using | difference_type = typename BaseClass::difference_type |
A signed integral type. Usually the same as ptrdiff_t. More... | |
| using | size_type = typename BaseClass::size_type |
An unsigned integral that can represent any non-negative value of difference_type. Usually the same as size_t. More... | |
| using | iterator = typename BaseClass::iterator |
Type representing a random-access iterator to a value_type. More... | |
| using | const_iterator = typename BaseClass::const_iterator |
Type representing a random-access iterator to a const value_type. More... | |
Public Member Functions | |
| Array () | |
| Construct an empty array. More... | |
| Array (size_type n) | |
Construct an array with n default initialized elements. More... | |
| Array (size_type n, const value_type &value) | |
Construct an array with n elements of value value. More... | |
| template<class InputIterator , typename = enable_if_input_iterator_t<InputIterator>> | |
| Array (InputIterator first, InputIterator last) | |
Construct an array with the values in the range [first,last), in the same order. More... | |
| Array (std::initializer_list< value_type > init) | |
| Construct an array with the contents of the initializer_list. More... | |
| Array (const Array< T > &other)=default | |
| Copy constructor. More... | |
| Array (Array< T > &&other) noexcept=default | |
| Move constructor. More... | |
| ~Array ()=default | |
| Destroys the array. This calls the destructor for each element, and releases all the storage allocated by the array. More... | |
| Array< T > & | operator= (const Array< T > &other)=default |
| Copy assignment operator. More... | |
| Array< T > & | operator= (Array< T > &&other) noexcept=default |
| Move assignment operator. More... | |
| Array< T > & | operator= (std::initializer_list< value_type > init) |
Copy all the elements from init into the current array. More... | |
| void | assign (size_type count, const value_type &value) |
Replaces the contents of the container with count copies of value value. More... | |
| template<class InputIterator , typename = enable_if_input_iterator_t<InputIterator>> | |
| void | assign (InputIterator first, InputIterator last) |
Replaces the contents of the container with copies of those in the range [first,last). More... | |
| void | assign (std::initializer_list< T > init) |
Replaces the contents of the container with the elements from the initializer list init. More... | |
| bool | empty () const noexcept |
Check whether the array is empty (size() == 0). More... | |
| size_type | size () const noexcept |
| Get the number of elements in the array. More... | |
| size_type | max_size () const |
| Return the maximum number of elements the array is able to hold due to system or library implementation limitations, i.e. std::distance(begin(), end()) for the largest possible container. More... | |
| void | reserve (size_type new_capacity) |
| Increase the capacity of the array to a value that's greater or equal to new_capacity. More... | |
| size_type | capacity () const noexcept |
| Get the number of elements that the container has currently allocated space for. More... | |
| void | shrink_to_fit () noexcept |
| Requests the removal of unused capacity. More... | |
| void | clear () noexcept |
| Removes all elements from the container. More... | |
| iterator | insert (const_iterator pos, size_type count, const value_type &value) |
| Inserts count copies of the value before pos. More... | |
| template<class InputIterator , typename = enable_if_input_iterator_t<InputIterator>> | |
| iterator | insert (const_iterator pos, InputIterator first, InputIterator last) |
Inserts elements from range [first,last) before pos. More... | |
| iterator | insert (const_iterator pos, std::initializer_list< value_type > init) |
| inserts elements from initializer list init before pos. More... | |
| iterator | erase (const_iterator pos) |
| Removes the element at pos from the container. More... | |
| iterator | erase (const_iterator first, const_iterator last) |
Removes the elements in the range [first,last) from the container. More... | |
| template<typename... Args, typename = enable_if_constructible_t<Args...>> | |
| void | emplace_back (Args &&... args) |
| Appends an element constructed from the given arguments to the end of the container. More... | |
| void | pop_back () |
| Removes the last element of the container. More... | |
| void | resize (size_type count) |
Resizes the container to contain count elements. More... | |
| void | resize (size_type count, const value_type &value) |
Resizes the container to contain count elements. More... | |
| void | swap (Array &other) noexcept |
| Exchange the content of the array by the content of other, which is another array object containing elements of the same type. More... | |
| reference | at (size_type n) |
Get a reference to the element at position n in the array. More... | |
| const_reference | at (size_type n) const |
Get a reference to the element at position n in the array. More... | |
| reference | operator[] (size_type n) |
Get a reference to the element at position n in the array. More... | |
| const_reference | operator[] (size_type n) const |
Get a reference to the element at position n in the array. More... | |
| reference | front () |
| Get a reference to the first element in the array. More... | |
| const_reference | front () const |
| Get a reference to the first element in the array. More... | |
| reference | back () |
| Get a reference to the last element in the array. More... | |
| const_reference | back () const |
| Get a reference to the last element in the array. More... | |
| pointer | data () noexcept |
| Get a pointer to the underlying storage of the array. More... | |
| const_pointer | data () const noexcept |
| Get a pointer to the underlying storage of the array. More... | |
| iterator | begin () noexcept |
| Get a iterator pointing to the first element in the array. More... | |
| const_iterator | begin () const noexcept |
| Get a iterator pointing to the first element in the array. More... | |
| const_iterator | cbegin () const noexcept |
| Get a iterator pointing to the first element in the array. More... | |
| iterator | end () noexcept |
| Get a iterator pointing to the element just past the last element in the array (past-the-end element). More... | |
| const_iterator | end () const noexcept |
| Get a iterator pointing to the element just past the last element in the array (past-the-end element). More... | |
| const_iterator | cend () const noexcept |
| Get a iterator pointing to the element just past the last element in the array (past-the-end element). More... | |
| iterator | insert (const_iterator pos, const value_type &value) |
| Inserts value before pos. More... | |
| iterator | insert (const_iterator pos, value_type &&value) |
| Inserts value before pos. More... | |
| void | push_back (const value_type &value) |
| Appends the given element value to the end of the container. More... | |
| void | push_back (value_type &&value) |
| Appends the given element value to the end of the container. More... | |
Detailed Description
class Amino::Array< T >
Define a Amino array of elements of type T.
Amino Arrays are resizable containers of contiguous elements.
- Warning
- Amino::Array is NOT a replacement for other contiguous containers (like std::vector). Amino::Array is only meant to be used within an Amino graph. Therefore, if a value never needs to flow directly into the graph, a standard container (like std::vector) should be used instead.
Amino Arrays of any Amino-known types can be used in Amino graphs, but they must always be memory managed by Amino::Ptr. If the element type is itself an Array or a custom user class, it must also be managed by an Amino::Ptr.
- Warning
- Amino::Array is not a replacement for std::vector or any other random access container. It is a type primarily meant to be used in Amino graphs (since its internal layout and details are known to the compiler).
- Template Parameters
-
T The type of the elements.
Member Typedef Documentation
◆ const_iterator
| using Amino::Array< T >::const_iterator = typename BaseClass::const_iterator |
◆ const_pointer
| using Amino::Array< T >::const_pointer = typename BaseClass::const_pointer |
◆ const_reference
| using Amino::Array< T >::const_reference = typename BaseClass::const_reference |
◆ difference_type
| using Amino::Array< T >::difference_type = typename BaseClass::difference_type |
◆ iterator
| using Amino::Array< T >::iterator = typename BaseClass::iterator |
◆ pointer
| using Amino::Array< T >::pointer = typename BaseClass::pointer |
◆ reference
| using Amino::Array< T >::reference = typename BaseClass::reference |
◆ size_type
| using Amino::Array< T >::size_type = typename BaseClass::size_type |
◆ value_type
| using Amino::Array< T >::value_type = typename BaseClass::value_type |
Constructor & Destructor Documentation
◆ Array() [1/7]
|
inlineexplicit |
◆ Array() [2/7]
|
inlineexplicit |
◆ Array() [3/7]
|
inline |
◆ Array() [4/7]
|
inline |
Construct an array with the values in the range [first,last), in the same order.
The range used is [first,last), which includes all the elements between first and last, including the element pointed by first, but not the element pointed by last.
- Template Parameters
-
InputIterator Input iterator type.
- Parameters
-
first Input iterator to the first position in the range. last Input iterator to the last position in the range.
◆ Array() [5/7]
|
inline |
◆ Array() [6/7]
|
default |
Copy constructor.
Construct a new array containing a copy of the elements in other, in the same order.
- Parameters
-
other An array of the same type whose elements are to be copied.
◆ Array() [7/7]
|
defaultnoexcept |
Move constructor.
Construct a new array taking ownership of the elements in other.
- Parameters
-
other An array of the same type whose elements are to be copied.
◆ ~Array()
|
default |
Destroys the array. This calls the destructor for each element, and releases all the storage allocated by the array.
Member Function Documentation
◆ assign() [1/3]
|
inline |
Replaces the contents of the container with copies of those in the range [first,last).
- Note
- This is almost equivalent to
*this = Array<T>(first, last)except that the already allocated memory by*thismay be reused if its capacity is large enough to holdstd::distance(first, last)elements.
- Parameters
-
first iterator to first element to copy last end iterator of range to copy
- Note
- Any elements held in the array before this call are destroyed.
- Container size will the same as the range after the call.
◆ assign() [2/3]
|
inline |
Replaces the contents of the container with count copies of value value.
- Note
- This is almost equivalent to
*this = Array<T>(count, value)except that the already allocated memory by*thismay be reused if its capacity is large enough to holdcountelements.
- Parameters
-
count the new size of the container. value the value to initialize elements of the container with.
- Note
- Any elements held in the array before this call are destroyed.
◆ assign() [3/3]
|
inline |
Replaces the contents of the container with the elements from the initializer list init.
- Note
- This is almost equivalent to
*this = Array<T>(init)except that the already allocated memory by*thismay be reused if its capacity is large enough to holdstd::distance(first, last)elements.
- Parameters
-
init initializer list to copy the values from
- Note
- Any elements held in the current array before this call are destroyed.
- Container size will the same as the initializer list after the call.
◆ at() [1/2]
|
inline |
Get a reference to the element at position n in the array.
- Warning
- Unlike std::vector::at(), Amino::Array::at() asserts if
n >= size(). That's because Amino::Array does not throw any exceptions, so it asserts instead.
- Precondition
n < size()
- Parameters
-
n The index of the element in the array.
- Returns
- A reference to the element at position
nin the array.
◆ at() [2/2]
|
inline |
Get a reference to the element at position n in the array.
- Warning
- Unlike std::vector::at(), Amino::Array::at() asserts if
n >= size(). That's because Amino::Array does not throw any exceptions, so it asserts instead.
- Precondition
n < size()
- Parameters
-
n The index of the element in the array.
- Returns
- A reference to the element at position
nin the array.
◆ back() [1/2]
|
inline |
Get a reference to the last element in the array.
Unlike end(), which returns an iterator just past the last element in the array, this function returns a direct reference to the last element.
- Precondition
!empty()
- Returns
- A reference to the last element in the array.
◆ back() [2/2]
|
inline |
Get a reference to the last element in the array.
Unlike end(), which returns an iterator just past the last element in the array, this function returns a direct reference to the last element.
- Precondition
!empty()
- Returns
- A reference to the last element in the array.
◆ begin() [1/2]
|
inlinenoexcept |
Get a iterator pointing to the first element in the array.
Unlike front(), which returns a direct reference to the first element in the array, this function returns a random-access iterator pointing to the first element. If the array is empty, the returned iterator is the same as end().
- Returns
- An iterator to the first element in the array.
◆ begin() [2/2]
|
inlinenoexcept |
Get a iterator pointing to the first element in the array.
Unlike front(), which returns a direct reference to the first element in the array, this function returns a random-access iterator pointing to the first element. If the array is empty, the returned iterator is the same as end().
- Returns
- An iterator to the first element in the array.
◆ capacity()
|
inlinenoexcept |
◆ cbegin()
|
inlinenoexcept |
Get a iterator pointing to the first element in the array.
Unlike front(), which returns a direct reference to the first element in the array, this function returns a random-access iterator pointing to the first element. If the array is empty, the returned iterator is the same as end().
- Returns
- An iterator to the first element in the array.
◆ cend()
|
inlinenoexcept |
Get a iterator pointing to the element just past the last element in the array (past-the-end element).
Unlike back(), which returns a reference to the last element in the array, this function returns a random-access iterator pointing past the last element. This iterator does not point to any valid element, and therefore should not be dereferenced. If the array is empty, the returned iterator is the same as begin().
- Returns
- An iterator pointing past the last element in the array.
◆ clear()
|
inlinenoexcept |
◆ data() [1/2]
|
inlinenoexcept |
◆ data() [2/2]
|
inlinenoexcept |
◆ emplace_back()
|
inline |
◆ empty()
|
inlinenoexcept |
◆ end() [1/2]
|
inlinenoexcept |
Get a iterator pointing to the element just past the last element in the array (past-the-end element).
Unlike back(), which returns a reference to the last element in the array, this function returns a random-access iterator pointing past the last element. This iterator does not point to any valid element, and therefore should not be dereferenced. If the array is empty, the returned iterator is the same as begin().
- Returns
- An iterator pointing past the last element in the array.
◆ end() [2/2]
|
inlinenoexcept |
Get a iterator pointing to the element just past the last element in the array (past-the-end element).
Unlike back(), which returns a reference to the last element in the array, this function returns a random-access iterator pointing past the last element. This iterator does not point to any valid element, and therefore should not be dereferenced. If the array is empty, the returned iterator is the same as begin().
- Returns
- An iterator pointing past the last element in the array.
◆ erase() [1/2]
|
inline |
Removes the elements in the range [first,last) from the container.
- Parameters
-
first beginning of range to remove last end of range to remove
- Returns
- Iterator following the last removed element. If the iterator pos refers to the last element, the end() iterator is returned.
◆ erase() [2/2]
|
inline |
Removes the element at pos from the container.
- Parameters
-
pos iterator to the element to remove. Must be valid and dereferenceable
- Returns
- Iterator following the last removed element. If the iterator pos refers to the last element, the end() iterator is returned.
◆ front() [1/2]
|
inline |
Get a reference to the first element in the array.
Unlike begin(), which returns an iterator to the first element in the array, this function returns a direct reference to the first element.
- Precondition
!empty()
- Returns
- A reference to the first element in the array.
◆ front() [2/2]
|
inline |
Get a reference to the first element in the array.
Unlike begin(), which returns an iterator to the first element in the array, this function returns a direct reference to the first element.
- Precondition
!empty()
- Returns
- A reference to the first element in the array.
◆ insert() [1/5]
|
inline |
◆ insert() [2/5]
|
inline |
Inserts elements from range [first,last) before pos.
- Parameters
-
pos iterator before which the content will be inserted. pos may be the end() iterator first iterator to first element to insert last end iterator of range to insert
- Warning
- first and last can't be iterators into container for which insert is called
- Precondition
(begin() <= pos && pos <= end())-
!(begin() <= first && first <= end()) -
!(begin() <= last && last <= end())
- Returns
- Iterator pointing to the first element inserted, or pos if first==last.
◆ insert() [3/5]
|
inline |
Inserts count copies of the value before pos.
- Parameters
-
pos iterator before which the content will be inserted. pos may be the end()iteratorcount number of copies to make value element value to copy
- Returns
- Iterator pointing to the first element inserted, or pos if count==0.
◆ insert() [4/5]
|
inline |
inserts elements from initializer list init before pos.
- Parameters
-
pos iterator before which the content will be inserted. pos may be the end() iterator init initializer list to insert the values from
- Returns
- Iterator pointing to the first element inserted, or pos if init is empty.
◆ insert() [5/5]
|
inline |
◆ max_size()
|
inline |
Return the maximum number of elements the array is able to hold due to system or library implementation limitations, i.e. std::distance(begin(), end()) for the largest possible container.
- Note
- This value typically reflects the theoretical limit on the size of the container, at most std::numeric_limits<difference_type>::max(). At runtime, the size of the container may be limited to a value smaller than max_size() by the amount of RAM available.
- Returns
- The theoretical maximum number of elements the array can hold.
◆ operator=() [1/3]
|
defaultnoexcept |
Move assignment operator.
Take ownership of all the elements of other into the current array. Any elements held in the current array before this call are destroyed.
- Parameters
-
other An array of the same type.
◆ operator=() [2/3]
|
default |
Copy assignment operator.
Copy all the elements from other into the current array. Any elements held in the current array before this call are destroyed.
- Parameters
-
other An array of the same type.
◆ operator=() [3/3]
|
inline |
◆ operator[]() [1/2]
|
inline |
◆ operator[]() [2/2]
|
inline |
◆ pop_back()
|
inline |
◆ push_back() [1/2]
|
inline |
◆ push_back() [2/2]
|
inline |
◆ reserve()
|
inline |
Increase the capacity of the array to a value that's greater or equal to new_capacity.
If new_capacity is greater than the current capacity(), new storage is allocated and elements are moved the that new storage, otherwise the method does nothing.
- Parameters
-
new_capacity The new capacity of the array.
◆ resize() [1/2]
|
inline |
Resizes the container to contain count elements.
If the current size is greater than count, the container is reduced to its first count elements. If the current size is less than count, additional default elements are appended.
- Postcondition
size() == count
- Parameters
-
count new size of the container.
◆ resize() [2/2]
|
inline |
Resizes the container to contain count elements.
If the current size is greater than count, the container is reduced to its first count elements. If the current size is less than count, additional copies of value are appended.
- Postcondition
size() == count
- Parameters
-
count new size of the container. value the value to initialize the new elements with.
◆ shrink_to_fit()
|
inlinenoexcept |
◆ size()
|
inlinenoexcept |
◆ swap()
|
inlinenoexcept |
Exchange the content of the array by the content of other, which is another array object containing elements of the same type.
Array sizes can be different.
After a call to this function, the elements in this array are those which were in other before the call, and the elements of other are those which were in this array. All iterators, references and pointers remain valid for the swapped arrays.
- Parameters
-
other An array of the same type the swap with.
Definition at line 608 of file Array.h.
References Amino::swap().
