A grouping of ArrayHandleStrides into an ArrayHandle of vtkm::Vecs.
More...
#include <ArrayHandleRecombineVec.h>
Public Types | |
| using | Thisclass = typename vtkm::cont::detail::GetTypeInParentheses< void(ArrayHandleRecombineVec< ComponentType >) >::type |
| using | Superclass = typename vtkm::cont::detail::GetTypeInParentheses< void(vtkm::cont::ArrayHandle< internal::detail::RecombinedValueType< ComponentType >, vtkm::cont::internal::StorageTagRecombineVec >) >::type |
| using | ValueType = typename Superclass::ValueType |
| using | StorageTag = typename Superclass::StorageTag |
| using | StorageType = typename Superclass::StorageType |
| using | ReadPortalType = typename Superclass::ReadPortalType |
| using | WritePortalType = typename Superclass::WritePortalType |
Public Member Functions | |
| ArrayHandleRecombineVec () | |
| VTKM_CONT | ArrayHandleRecombineVec (const Thisclass &src) |
| VTKM_CONT | ArrayHandleRecombineVec (Thisclass &&src) noexcept |
| VTKM_CONT | ArrayHandleRecombineVec (const vtkm::cont::ArrayHandle< typename Superclass::ValueType, typename Superclass::StorageTag > &src) |
| VTKM_CONT | ArrayHandleRecombineVec (vtkm::cont::ArrayHandle< typename Superclass::ValueType, typename Superclass::StorageTag > &&src) noexcept |
| VTKM_CONT | ArrayHandleRecombineVec (const std::vector< vtkm::cont::internal::Buffer > &buffers) |
| VTKM_CONT | ArrayHandleRecombineVec (std::vector< vtkm::cont::internal::Buffer > &&buffers) noexcept |
| VTKM_CONT Thisclass & | operator= (const Thisclass &src) |
| VTKM_CONT Thisclass & | operator= (Thisclass &&src) noexcept |
| vtkm::IdComponent | GetNumberOfComponents () const |
| Return the number of components in each value of the array. More... | |
| vtkm::cont::ArrayHandleStride< ComponentType > | GetComponentArray (vtkm::IdComponent componentIndex) const |
| Get the array storing the values for a particular component. More... | |
| void | AppendComponentArray (const vtkm::cont::ArrayHandle< ComponentType, vtkm::cont::StorageTagStride > &array) |
| Add a component array. More... | |
Detailed Description
template<typename ComponentType>
class vtkm::cont::ArrayHandleRecombineVec< ComponentType >
A grouping of ArrayHandleStrides into an ArrayHandle of vtkm::Vecs.
The main intention of ArrayHandleStride is to pull out a component of an ArrayHandle without knowing there ArrayHandle's storage or vtkm::Vec shape. However, usually you want to do an operation on all the components together. ArrayHandleRecombineVec implements the functionality to easily take a group of extracted components and treat them as a single ArrayHandle of vtkm::Vec values.
Note that caution should be used with ArrayHandleRecombineVec because the size of the vtkm::Vec values is not known at compile time. Thus, the value type of this array is forced to a special RecombineVec class that can cause surprises if treated as a vtkm::Vec. In particular, the static NUM_COMPONENTS expression does not exist. Furthermore, new variables of type RecombineVec cannot be created. This means that simple operators like + will not work because they require an intermediate object to be created. (Equal operators like += do work because they are given an existing variable to place the output.)
Member Typedef Documentation
◆ ReadPortalType
| using vtkm::cont::ArrayHandleRecombineVec< ComponentType >::ReadPortalType = typename Superclass::ReadPortalType |
◆ StorageTag
| using vtkm::cont::ArrayHandleRecombineVec< ComponentType >::StorageTag = typename Superclass::StorageTag |
◆ StorageType
| using vtkm::cont::ArrayHandleRecombineVec< ComponentType >::StorageType = typename Superclass::StorageType |
◆ Superclass
| using vtkm::cont::ArrayHandleRecombineVec< ComponentType >::Superclass = typename vtkm::cont::detail::GetTypeInParentheses<void (vtkm::cont::ArrayHandle<internal::detail::RecombinedValueType<ComponentType>, vtkm::cont::internal::StorageTagRecombineVec>) >::type |
◆ Thisclass
| using vtkm::cont::ArrayHandleRecombineVec< ComponentType >::Thisclass = typename vtkm::cont::detail::GetTypeInParentheses<void (ArrayHandleRecombineVec<ComponentType>) >::type |
◆ ValueType
| using vtkm::cont::ArrayHandleRecombineVec< ComponentType >::ValueType = typename Superclass::ValueType |
◆ WritePortalType
| using vtkm::cont::ArrayHandleRecombineVec< ComponentType >::WritePortalType = typename Superclass::WritePortalType |
Constructor & Destructor Documentation
◆ ArrayHandleRecombineVec() [1/7]
|
inline |
◆ ArrayHandleRecombineVec() [2/7]
|
inline |
◆ ArrayHandleRecombineVec() [3/7]
|
inlinenoexcept |
◆ ArrayHandleRecombineVec() [4/7]
|
inline |
◆ ArrayHandleRecombineVec() [5/7]
|
inlinenoexcept |
◆ ArrayHandleRecombineVec() [6/7]
|
inlineexplicit |
◆ ArrayHandleRecombineVec() [7/7]
|
inlineexplicitnoexcept |
Member Function Documentation
◆ AppendComponentArray()
|
inline |
Add a component array.
AppendComponentArray() provides an easy way to build an ArrayHandleRecombineVec by iteratively adding the component arrays.
◆ GetComponentArray()
|
inline |
Get the array storing the values for a particular component.
The returned array is a vtkm::cont::ArrayHandleStride. It is possible that the returned arrays from different components reference the same area of physical memory (usually referencing values interleaved with each other).
◆ GetNumberOfComponents()
|
inline |
Return the number of components in each value of the array.
This is also equal to the number of component arrays referenced by this fancy array.
ArrayHandleRecombineVec always stores flat Vec values. As such, this number of components is the same as the number of base components.
◆ operator=() [1/2]
|
inline |
◆ operator=() [2/2]
|
inlinenoexcept |
The documentation for this class was generated from the following file:
