An array wrapper for easy copying, comparing, and iterating.
More...
#include <AH/Containers/Array.hpp>
|
T & | operator[] (size_t index) |
| Get the element at the given index. More...
|
|
const T & | operator[] (size_t index) const |
| Get the element at the given index. More...
|
|
T * | begin () |
| Get a pointer to the first element. More...
|
|
const T * | begin () const |
| Get a pointer to the first element. More...
|
|
T * | end () |
| Get a pointer to the memory beyond the array. More...
|
|
const T * | end () const |
| Get a pointer to the memory beyond the array. More...
|
|
bool | operator== (const Array< T, N > &rhs) const |
| Check the equality of all elements in two arrays. More...
|
|
bool | operator!= (const Array< T, N > &rhs) const |
| Check the inequality of all elements in two arrays. More...
|
|
template<size_t Start = 0, size_t End = N - 1> |
ArraySlice< T, abs_diff(Start, End)+1,(End< Start), false > | slice () |
| Get a view on a slice of the Array. More...
|
|
template<size_t Start = 0, size_t End = N - 1> |
ArraySlice< T, abs_diff(Start, End)+1,(End< Start), true > | slice () const |
| Get a read-only view on a slice of the Array. More...
|
|
template<size_t Start = 0, size_t End = N - 1> |
ArraySlice< T, abs_diff(Start, End)+1,(End< Start), true > | cslice () const |
| Get a read-only view on a slice of the Array. More...
|
|
|
constexpr static size_t | length = N |
|
template<class T, size_t N>
struct AH::Array< T, N >
An array wrapper for easy copying, comparing, and iterating.
- Template Parameters
-
T | The type of the elements in the array. |
N | The number of elements in the array. |
Definition at line 36 of file Array.hpp.
◆ type
◆ operator[]() [1/2]
T& operator[] |
( |
size_t |
index | ) |
|
|
inline |
Get the element at the given index.
- Note
- Bounds checking is performed. If fatal errors are disabled, the last element is returned if the index is out of bounds.
- Parameters
-
index | The (zero-based) index of the element to return. |
Definition at line 50 of file Array.hpp.
◆ operator[]() [2/2]
const T& operator[] |
( |
size_t |
index | ) |
const |
|
inline |
Get the element at the given index.
- Note
- Bounds checking is performed. If fatal errors are disabled, the last element is returned if the index is out of bounds.
- Parameters
-
index | The (zero-based) index of the element to return. |
Definition at line 67 of file Array.hpp.
◆ begin() [1/2]
Get a pointer to the first element.
Definition at line 78 of file Array.hpp.
◆ begin() [2/2]
Get a pointer to the first element.
Definition at line 83 of file Array.hpp.
◆ end() [1/2]
Get a pointer to the memory beyond the array.
Definition at line 88 of file Array.hpp.
◆ end() [2/2]
Get a pointer to the memory beyond the array.
Definition at line 93 of file Array.hpp.
◆ operator==()
bool operator== |
( |
const Array< T, N > & |
rhs | ) |
const |
|
inline |
Check the equality of all elements in two arrays.
- Parameters
-
rhs | The array to compare this array to. |
Definition at line 101 of file Array.hpp.
◆ operator!=()
bool operator!= |
( |
const Array< T, N > & |
rhs | ) |
const |
|
inline |
Check the inequality of all elements in two arrays.
- Parameters
-
rhs | The array to compare this array to. |
Definition at line 116 of file Array.hpp.
◆ slice() [1/2]
Get a view on a slice of the Array.
Doesn't copy the contents of the array, it's just a reference to the original array.
- Template Parameters
-
Start | The start index of the slice. |
End | The end index of the slice. |
◆ slice() [2/2]
Get a read-only view on a slice of the Array.
Doesn't copy the contents of the array, it's just a reference to the original array.
- Template Parameters
-
Start | The start index of the slice. |
End | The end index of the slice. |
◆ cslice()
Get a read-only view on a slice of the Array.
Doesn't copy the contents of the array, it's just a reference to the original array.
- Template Parameters
-
Start | The start index of the slice. |
End | The end index of the slice. |
Definition at line 146 of file Array.hpp.
◆ data
◆ length
constexpr static size_t length = N |
|
staticconstexpr |
The documentation for this struct was generated from the following file: