Array implementation specific to 1D Arrays.
More...
#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/core/ArrayBase.hpp>
|
using | RealConstT = typename std::conditional< is_array_view, T, const T >::type |
|
|
AXOM_HOST_DEVICE | ArrayBase (IndexType=0) |
|
AXOM_HOST_DEVICE | ArrayBase (const StackArray< IndexType, 1 > &, int stride=1) |
|
AXOM_HOST_DEVICE | ArrayBase (const StackArray< IndexType, 1 > &, const StackArray< IndexType, 1 > &stride) |
|
template<typename OtherArrayType > |
| ArrayBase (const ArrayBase< typename std::remove_const< T >::type, 1, OtherArrayType > &) |
|
template<typename OtherArrayType > |
| ArrayBase (const ArrayBase< const typename std::remove_const< T >::type, 1, OtherArrayType > &) |
|
AXOM_HOST_DEVICE StackArray< IndexType, 1 > | shape () const |
| Returns the dimensions of the Array. More...
|
|
AXOM_HOST_DEVICE IndexType | minStride () const |
| Returns the stride between adjacent items. More...
|
|
void | swap (ArrayBase &) |
| Swaps two ArrayBases No member data, so this is a no-op. More...
|
|
AXOM_HOST_DEVICE void | setShape (const StackArray< IndexType, 1 > &) |
| Set the shape No member data, so this is a no-op. More...
|
|
|
AXOM_HOST_DEVICE T & | operator[] (const IndexType idx) |
| Accessor, returns a reference to the given value. For multidimensional arrays, indexes into the (flat) raw data. More...
|
|
AXOM_HOST_DEVICE RealConstT & | operator[] (const IndexType idx) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
|
|
AXOM_HOST_DEVICE T & | flatIndex (const IndexType idx) |
| Accessor, returns a reference to the given value. For multidimensional arrays, indexes into the (flat) raw data. More...
|
|
AXOM_HOST_DEVICE RealConstT & | flatIndex (const IndexType idx) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
|
|
template<typename T, typename ArrayType>
class axom::ArrayBase< T, 1, ArrayType >
Array implementation specific to 1D Arrays.
◆ RealConstT
template<typename T , typename ArrayType >
◆ ArrayBase() [1/5]
template<typename T , typename ArrayType >
◆ ArrayBase() [2/5]
template<typename T , typename ArrayType >
◆ ArrayBase() [3/5]
template<typename T , typename ArrayType >
◆ ArrayBase() [4/5]
template<typename T , typename ArrayType >
template<typename OtherArrayType >
◆ ArrayBase() [5/5]
template<typename T , typename ArrayType >
template<typename OtherArrayType >
◆ shape()
template<typename T , typename ArrayType >
Returns the dimensions of the Array.
◆ minStride()
template<typename T , typename ArrayType >
Returns the stride between adjacent items.
◆ operator[]() [1/2]
template<typename T , typename ArrayType >
Accessor, returns a reference to the given value. For multidimensional arrays, indexes into the (flat) raw data.
- Parameters
-
[in] | idx | the position of the value to return. |
- Note
- equivalent to *(array.data() + idx * array.spacing()).
- Precondition
- 0 <= idx < asDerived().size()
◆ operator[]() [2/2]
template<typename T , typename ArrayType >
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
◆ flatIndex() [1/2]
template<typename T , typename ArrayType >
Accessor, returns a reference to the given value. For multidimensional arrays, indexes into the (flat) raw data.
- Parameters
-
[in] | idx | the position of the value to return. |
- Note
- equivalent to *(array.data() + idx * array.minStride()).
- Precondition
- 0 <= idx < asDerived().size()
◆ flatIndex() [2/2]
template<typename T , typename ArrayType >
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
◆ swap()
template<typename T , typename ArrayType >
Swaps two ArrayBases No member data, so this is a no-op.
◆ setShape()
template<typename T , typename ArrayType >
Set the shape No member data, so this is a no-op.
◆ blockSize()
template<typename T , typename ArrayType >
Returns the minimum "chunk size" that should be allocated.
◆ updateShapeOnInsert()
template<typename T , typename ArrayType >
Updates the internal dimensions and striding based on the insertion of a range of elements. No-op, since we don't keep any shape information in this specialization.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/core/ArrayBase.hpp