Proxy class for efficiently constructing slice ArrayViews by using the generic ArrayBase constructor in ArrayView. This avoids the cost of looking up the correct allocator ID from the other ArrayView constructors. More...
#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/core/ArrayBase.hpp>
Public Types | |
| using | RealConstT = typename std::conditional< is_array_view, T, const T >::type |
| using | ConstSliceType = typename std::conditional< DIM==IdxDim, RealConstT &, typename detail::SubsliceProxy< T, DIM - IdxDim, const ArraySubslice< T, SliceDim, BaseArray > >::type >::type |
Public Member Functions | |
| AXOM_HOST_DEVICE | ArraySubslice (BaseArray *array, const StackArray< IndexType, NumIndices > &idxs) |
| AXOM_HOST_DEVICE IndexType | size () const |
| Return the number of elements stored in the data array. More... | |
| IndexType | spacing () const |
| AXOM_HOST_DEVICE int | getAllocatorID () const |
| Get the ID for the umpire allocator. More... | |
| AXOM_HOST_DEVICE SliceType< sizeof...(Args)> | operator() (Args... args) |
| Dimension-aware accessor; with N=DIM indices, returns a reference to the given value at that index. Otherwise, returns a sub-array pointed to by the given sub-index. More... | |
| AXOM_HOST_DEVICE ConstSliceType< sizeof...(Args)> | operator() (Args... args) 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 SliceType< 1 > | operator[] (const IndexType idx) |
| Scalar accessor; returns a sub-array referenced by the given sub- index, beginning at array(idx, 0...) More... | |
| AXOM_HOST_DEVICE ConstSliceType< 1 > | 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 SliceType< UDim > | operator[] (const StackArray< IndexType, UDim > &idx) |
| Dimension-aware accessor; with UDim=DIM indices, returns a reference to the given value at that index. Otherwise, returns a sub-array pointed to by the given sub-index. More... | |
| AXOM_HOST_DEVICE ConstSliceType< UDim > | operator[] (const StackArray< IndexType, UDim > &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... | |
| void | swap (ArrayBase &other) |
| Swaps two ArrayBases. More... | |
| AXOM_HOST_DEVICE const StackArray< IndexType, DIM > & | shape () const |
| Returns the dimensions of the Array. More... | |
| AXOM_HOST_DEVICE const MDMapping< DIM > & | mapping () const |
| Returns the multidimensional mapping for the Array. More... | |
| AXOM_HOST_DEVICE const StackArray< IndexType, DIM > & | strides () const |
| Returns the memory strides of the Array. More... | |
| AXOM_HOST_DEVICE IndexType | minStride () const |
| Returns the minimum stride between adjacent items. More... | |
| AXOM_HOST_DEVICE T * | data () const |
| Return a pointer to the array of data. 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... | |
Static Public Attributes | |
| constexpr static int | Dims |
Protected Member Functions | |
| template<int UDim> | |
| AXOM_HOST_DEVICE SliceType< UDim > | sliceImpl (const StackArray< IndexType, UDim > &idx) const |
| AXOM_HOST_DEVICE void | setShape (const StackArray< IndexType, DIM > &shape_) |
| Set the shape. More... | |
| AXOM_SUPPRESS_HD_WARN AXOM_HOST_DEVICE void | setShapeAndStride (const StackArray< IndexType, DIM > &shape, const StackArray< IndexType, DIM > &stride) |
| Set the shape and stride. More... | |
| IndexType | blockSize () const |
| Returns the minimum "chunk size" that should be allocated For example, 2 would be the chunk size of a 2D array whose second dimension is of size 2. This is used when resizing/reallocating; it wouldn't make sense to have a capacity of 3 in the array described above. More... | |
| AXOM_HOST_DEVICE void | updateStrides (int min_stride=1) |
| Updates the internal striding information to a row-major format Intended to be called after shape is updated. More... | |
| void | updateShapeOnInsert (const StackArray< IndexType, DIM > &range_shape) |
| Updates the internal dimensions and striding based on the insertion of a range of elements. Intended to be called after the insertion of a multidimensional subslice. More... | |
Protected Attributes | |
| friend | BaseClass |
| StackArray< IndexType, DIM > | m_shape |
| The extent in each direction. More... | |
| MDMapping< DIM > | m_mapping |
| For converting between multidim indices and offset. More... | |
| IndexType | m_minStride |
| Cached value for optimization. More... | |
Detailed Description
template<typename T, int SliceDim, typename BaseArray>
class axom::detail::ArraySubslice< T, SliceDim, BaseArray >
Proxy class for efficiently constructing slice ArrayViews by using the generic ArrayBase constructor in ArrayView. This avoids the cost of looking up the correct allocator ID from the other ArrayView constructors.
Member Typedef Documentation
◆ RealConstT
|
inherited |
◆ ConstSliceType
|
inherited |
Constructor & Destructor Documentation
◆ ArraySubslice()
|
inline |
Member Function Documentation
◆ size()
|
inline |
Return the number of elements stored in the data array.
◆ data()
|
inline |
Return a pointer to the array of data.
References axom::StackArray< T, N >::begin(), and axom::numerics::dot_product().
◆ spacing()
|
inline |
◆ getAllocatorID()
|
inline |
Get the ID for the umpire allocator.
◆ sliceImpl()
|
inlineprotected |
◆ operator()() [1/2]
|
inlineinherited |
Dimension-aware accessor; with N=DIM indices, returns a reference to the given value at that index. Otherwise, returns a sub-array pointed to by the given sub-index.
- Parameters
-
[in] args the parameter pack of indices in each dimension.
- Note
- equivalent to *(array.data() + idx).
- Precondition
- sizeof...(Args) <= DIM
- 0 <= args[i] < shape()[i] for i in [0, sizeof...(Args))
◆ operator()() [2/2]
|
inlineinherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
◆ operator[]() [1/4]
|
inlineinherited |
Scalar accessor; returns a sub-array referenced by the given sub- index, beginning at array(idx, 0...)
- Parameters
-
[in] idx the index of the first dimension.
- Precondition
- 0 <= idx < shape()[0]
◆ operator[]() [2/4]
|
inlineinherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
◆ operator[]() [3/4]
|
inlineinherited |
Dimension-aware accessor; with UDim=DIM indices, returns a reference to the given value at that index. Otherwise, returns a sub-array pointed to by the given sub-index.
- Parameters
-
[in] args a stack array of indices in each dimension.
- Note
- equivalent to *(array.data() + idx).
- Precondition
- UDim <= DIM
- 0 <= args[i] < shape()[i] for i in [0, UDim)
◆ operator[]() [4/4]
|
inlineinherited |
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]
|
inlineinherited |
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 * minStride()).
- Precondition
- 0 <= idx < asDerived().size()
◆ flatIndex() [2/2]
|
inlineinherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
◆ swap()
|
inlineinherited |
Swaps two ArrayBases.
◆ shape()
|
inlineinherited |
Returns the dimensions of the Array.
◆ mapping()
|
inlineinherited |
Returns the multidimensional mapping for the Array.
◆ strides()
|
inlineinherited |
Returns the memory strides of the Array.
◆ minStride()
|
inlineinherited |
Returns the minimum stride between adjacent items.
◆ setShape()
|
inlineprotectedinherited |
Set the shape.
◆ setShapeAndStride()
|
inlineprotectedinherited |
Set the shape and stride.
◆ blockSize()
|
inlineprotectedinherited |
Returns the minimum "chunk size" that should be allocated For example, 2 would be the chunk size of a 2D array whose second dimension is of size 2. This is used when resizing/reallocating; it wouldn't make sense to have a capacity of 3 in the array described above.
◆ updateStrides()
|
inlineprotectedinherited |
Updates the internal striding information to a row-major format Intended to be called after shape is updated.
◆ updateShapeOnInsert()
|
inlineprotectedinherited |
Updates the internal dimensions and striding based on the insertion of a range of elements. Intended to be called after the insertion of a multidimensional subslice.
Member Data Documentation
◆ BaseClass
|
protected |
◆ Dims
|
staticconstexprinherited |
◆ m_shape
|
protectedinherited |
The extent in each direction.
◆ m_mapping
|
protectedinherited |
For converting between multidim indices and offset.
◆ m_minStride
|
protectedinherited |
Cached value for optimization.
- See also
- minStride()
For some reason, computing min stride in minStride() slows down flatIndex() for CUDA and HIP, even though it doesn't seem tricky to optimize. As a work around, we cache the value in m_minStrides and update it when m_mapping changes. BTNG, March 2024.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/core/ArrayBase.hpp
