VTK-m  1.8
Public Types | Public Member Functions | Private Member Functions | List of all members
vtkm::cont::ArrayHandleGroupVec< ComponentsArrayHandleType, NUM_COMPONENTS > Class Template Reference

Fancy array handle that groups values into vectors. More...

#include <ArrayHandleGroupVec.h>

Inheritance diagram for vtkm::cont::ArrayHandleGroupVec< ComponentsArrayHandleType, NUM_COMPONENTS >:
vtkm::cont::ArrayHandle< vtkm::Vec< ComponentsArrayHandleType::ValueType, NUM_COMPONENTS >, vtkm::cont::StorageTagGroupVec< ComponentsArrayHandleType::StorageTag, NUM_COMPONENTS > >

Public Types

using ComponentType = typename ComponentsArrayHandleType::ValueType
 
- Public Types inherited from vtkm::cont::ArrayHandle< vtkm::Vec< ComponentsArrayHandleType::ValueType, NUM_COMPONENTS >, vtkm::cont::StorageTagGroupVec< ComponentsArrayHandleType::StorageTag, NUM_COMPONENTS > >
using ValueType = vtkm::Vec< ComponentsArrayHandleType::ValueType, NUM_COMPONENTS >
 
using StorageTag = vtkm::cont::StorageTagGroupVec< ComponentsArrayHandleType::StorageTag, NUM_COMPONENTS >
 
using StorageType = vtkm::cont::internal::Storage< ValueType, StorageTag >
 
using ReadPortalType = typename StorageType::ReadPortalType
 
using WritePortalType = typename StorageType::WritePortalType
 
using instead = WritePortalType
 
using instead = ReadPortalType
 

Public Member Functions

 VTKM_ARRAY_HANDLE_SUBCLASS (ArrayHandleGroupVec,(ArrayHandleGroupVec< ComponentsArrayHandleType, NUM_COMPONENTS >),(vtkm::cont::ArrayHandle< vtkm::Vec< typename ComponentsArrayHandleType::ValueType, NUM_COMPONENTS >, vtkm::cont::StorageTagGroupVec< typename ComponentsArrayHandleType::StorageTag, NUM_COMPONENTS >>))
 
VTKM_CONT ArrayHandleGroupVec (const ComponentsArrayHandleType &componentsArray)
 
VTKM_CONT ComponentsArrayHandleType GetComponentsArray () const
 
- Public Member Functions inherited from vtkm::cont::ArrayHandle< vtkm::Vec< ComponentsArrayHandleType::ValueType, NUM_COMPONENTS >, vtkm::cont::StorageTagGroupVec< ComponentsArrayHandleType::StorageTag, NUM_COMPONENTS > >
struct VTKM_DEPRECATED (1.6, "Use ReadPortalType and WritePortalType.") ExecutionTypes
 
VTKM_CONT VTKM_DEPRECATED (1.6, "Use ArrayHandle::WritePortal() instead. " "Note that the returned portal will lock the array while it is in scope.") VTKM_CONT VTKM_DEPRECATED(1.6
 Get the array portal of the control array. More...
 
 VTKM_DEPRECATED (1.6, "Use Allocate(n, vtkm::CopyFlag::On) instead of Shrink(n).") VTKM_CONT void Shrink(vtkm
 
VTKM_CONT VTKM_DEPRECATED (1.6, "PrepareForInput now requires a vtkm::cont::Token object.") ReadPortalType PrepareForInput(vtkm
 
VTKM_CONT ArrayHandle ()
 Constructs an empty ArrayHandle. More...
 
VTKM_CONT ArrayHandle (const vtkm::cont::ArrayHandle< ValueType, StorageTag > &src)
 Copy constructor. More...
 
VTKM_CONT ArrayHandle (vtkm::cont::ArrayHandle< ValueType, StorageTag > &&src) noexcept
 Move constructor. More...
 
VTKM_CONT ~ArrayHandle ()
 Destructs an empty ArrayHandle. More...
 
VTKM_CONT vtkm::cont::ArrayHandle< ValueType, StorageTag > & operator= (const vtkm::cont::ArrayHandle< ValueType, StorageTag > &src)
 Copies an ArrayHandle. More...
 
VTKM_CONT vtkm::cont::ArrayHandle< ValueType, StorageTag > & operator= (vtkm::cont::ArrayHandle< ValueType, StorageTag > &&src) noexcept
 Move and Assignment of an ArrayHandle. More...
 
VTKM_CONT bool operator== (const ArrayHandle< ValueType, StorageTag > &rhs) const
 Like a pointer, two ArrayHandles are considered equal if they point to the same location in memory. More...
 
VTKM_CONT bool operator== (const ArrayHandle< VT, ST > &) const
 
VTKM_CONT bool operator!= (const ArrayHandle< ValueType, StorageTag > &rhs) const
 
VTKM_CONT bool operator!= (const ArrayHandle< VT, ST > &) const
 
VTKM_CONT StorageType GetStorage () const
 Get the storage. More...
 
VTKM_CONT Use ArrayHandle::ReadPortal () instead. " "Note that the returned portal will lock the array while it is in scope.") VTKM_CONT ReadPortalType ReadPortal() const
 Get an array portal that can be used in the control environment. More...
 
VTKM_CONT WritePortalType WritePortal () const
 Get an array portal that can be used in the control environment. More...
 
VTKM_CONT vtkm::Id GetNumberOfValues () const
 Returns the number of entries in the array. More...
 
VTKM_CONT void ReleaseResourcesExecution () const
 Releases any resources being used in the execution environment (that are not being shared by the control environment). More...
 
VTKM_CONT void ReleaseResources () const
 Releases all resources in both the control and execution environments. More...
 
VTKM_CONT ReadPortalType PrepareForInput (vtkm::cont::DeviceAdapterId device, vtkm::cont::Token &token) const
 Prepares this array to be used as an input to an operation in the execution environment. More...
 
VTKM_CONT WritePortalType PrepareForInPlace (vtkm::cont::DeviceAdapterId device, vtkm::cont::Token &token) const
 Prepares this array to be used in an in-place operation (both as input and output) in the execution environment. More...
 
VTKM_CONT WritePortalType PrepareForOutput (vtkm::Id numberOfValues, vtkm::cont::DeviceAdapterId device, vtkm::cont::Token &token) const
 Prepares (allocates) this array to be used as an output from an operation in the execution environment. More...
 
VTKM_CONT ArrayHandle (const std::vector< vtkm::cont::internal::Buffer > &buffers)
 
VTKM_CONT ArrayHandle (std::vector< vtkm::cont::internal::Buffer > &&buffers) noexcept
 
VTKM_CONT ArrayHandle (const vtkm::cont::internal::Buffer *buffers)
 
VTKM_CONT void Allocate (vtkm::Id numberOfValues, vtkm::CopyFlag preserve, vtkm::cont::Token &token) const
 Allocates an array large enough to hold the given number of values. More...
 
VTKM_CONT void Allocate (vtkm::Id numberOfValues, vtkm::CopyFlag preserve=vtkm::CopyFlag::Off) const
 Allocates an array large enough to hold the given number of values. More...
 
VTKM_CONT void AllocateAndFill (vtkm::Id numberOfValues, const ValueType &fillValue, vtkm::CopyFlag preserve, vtkm::cont::Token &token) const
 Allocates an array and fills it with an initial value. More...
 
VTKM_CONT void AllocateAndFill (vtkm::Id numberOfValues, const ValueType &fillValue, vtkm::CopyFlag preserve=vtkm::CopyFlag::Off) const
 Allocates an array and fills it with an initial value. More...
 
VTKM_CONT void Fill (const ValueType &fillValue, vtkm::Id startIndex, vtkm::Id endIndex, vtkm::cont::Token &token) const
 Fills the array with a given value. More...
 
VTKM_CONT void Fill (const ValueType &fillValue, vtkm::Id startIndex, vtkm::Id endIndex) const
 Fills the array with a given value. More...
 
VTKM_CONT void Fill (const ValueType &fillValue, vtkm::Id startIndex=0) const
 Fills the array with a given value. More...
 

Private Member Functions

 VTKM_IS_ARRAY_HANDLE (ComponentsArrayHandleType)
 

Additional Inherited Members

- Static Public Member Functions inherited from vtkm::cont::ArrayHandle< vtkm::Vec< ComponentsArrayHandleType::ValueType, NUM_COMPONENTS >, vtkm::cont::StorageTagGroupVec< ComponentsArrayHandleType::StorageTag, NUM_COMPONENTS > >
static constexpr VTKM_CONT vtkm::IdComponent GetNumberOfBuffers ()
 
- Protected Member Functions inherited from vtkm::cont::ArrayHandle< vtkm::Vec< ComponentsArrayHandleType::ValueType, NUM_COMPONENTS >, vtkm::cont::StorageTagGroupVec< ComponentsArrayHandleType::StorageTag, NUM_COMPONENTS > >
VTKM_CONT void SetBuffer (vtkm::IdComponent index, const vtkm::cont::internal::Buffer &buffer)
 Returns true if the ArrayHandle's data is on the given device. More...
 
VTKM_CONT void SetBuffers (const BufferContainer &buffers)
 

Detailed Description

template<typename ComponentsArrayHandleType, vtkm::IdComponent NUM_COMPONENTS>
class vtkm::cont::ArrayHandleGroupVec< ComponentsArrayHandleType, NUM_COMPONENTS >

Fancy array handle that groups values into vectors.

It is sometimes the case that an array is stored such that consecutive entries are meant to form a group. This fancy array handle takes an array of values and a size of groups and then groups the consecutive values stored in a Vec.

For example, if you have an array handle with the six values 0,1,2,3,4,5 and give it to a ArrayHandleGroupVec with the number of components set to 3, you get an array that looks like it contains two values of Vec values of size 3 with the data [0,1,2], [3,4,5].

The array of components should have a number of values that divides evenly with the size of the Vec. If the components array does not divide evenly into Vecs, then a warning will be logged and the extra component values will be ignored.

Member Typedef Documentation

◆ ComponentType

template<typename ComponentsArrayHandleType , vtkm::IdComponent NUM_COMPONENTS>
using vtkm::cont::ArrayHandleGroupVec< ComponentsArrayHandleType, NUM_COMPONENTS >::ComponentType = typename ComponentsArrayHandleType::ValueType

Constructor & Destructor Documentation

◆ ArrayHandleGroupVec()

template<typename ComponentsArrayHandleType , vtkm::IdComponent NUM_COMPONENTS>
VTKM_CONT vtkm::cont::ArrayHandleGroupVec< ComponentsArrayHandleType, NUM_COMPONENTS >::ArrayHandleGroupVec ( const ComponentsArrayHandleType &  componentsArray)
inline

Member Function Documentation

◆ GetComponentsArray()

template<typename ComponentsArrayHandleType , vtkm::IdComponent NUM_COMPONENTS>
VTKM_CONT ComponentsArrayHandleType vtkm::cont::ArrayHandleGroupVec< ComponentsArrayHandleType, NUM_COMPONENTS >::GetComponentsArray ( ) const
inline

◆ VTKM_ARRAY_HANDLE_SUBCLASS()

template<typename ComponentsArrayHandleType , vtkm::IdComponent NUM_COMPONENTS>
vtkm::cont::ArrayHandleGroupVec< ComponentsArrayHandleType, NUM_COMPONENTS >::VTKM_ARRAY_HANDLE_SUBCLASS ( ArrayHandleGroupVec< ComponentsArrayHandleType, NUM_COMPONENTS >  ,
(ArrayHandleGroupVec< ComponentsArrayHandleType, NUM_COMPONENTS >)  ,
(vtkm::cont::ArrayHandle< vtkm::Vec< typename ComponentsArrayHandleType::ValueType, NUM_COMPONENTS >, vtkm::cont::StorageTagGroupVec< typename ComponentsArrayHandleType::StorageTag, NUM_COMPONENTS >>)   
)

◆ VTKM_IS_ARRAY_HANDLE()

template<typename ComponentsArrayHandleType , vtkm::IdComponent NUM_COMPONENTS>
vtkm::cont::ArrayHandleGroupVec< ComponentsArrayHandleType, NUM_COMPONENTS >::VTKM_IS_ARRAY_HANDLE ( ComponentsArrayHandleType  )
private

The documentation for this class was generated from the following file: