VTK-m  1.8
Public Member Functions | Private Member Functions | List of all members
vtkm::cont::ArrayHandleZip< FirstHandleType, SecondHandleType > Class Template Reference

ArrayHandleZip is a specialization of ArrayHandle. More...

#include <ArrayHandleZip.h>

Inheritance diagram for vtkm::cont::ArrayHandleZip< FirstHandleType, SecondHandleType >:
vtkm::cont::ArrayHandle< T, StorageTag_ >

Public Member Functions

 VTKM_ARRAY_HANDLE_SUBCLASS (ArrayHandleZip,(ArrayHandleZip< FirstHandleType, SecondHandleType >),(typename internal::ArrayHandleZipTraits< FirstHandleType, SecondHandleType >::Superclass))
 
VTKM_CONT ArrayHandleZip (const FirstHandleType &firstArray, const SecondHandleType &secondArray)
 
FirstHandleType GetFirstArray () const
 
SecondHandleType GetSecondArray () const
 
- Public Member Functions inherited from vtkm::cont::ArrayHandle< T, StorageTag_ >
template<typename Device >
struct VTKM_DEPRECATED (1.6, "Use ReadPortalType and WritePortalType.") ExecutionTypes
 
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< ValueType, StorageTag > &rhs) const
 
template<typename VT , typename ST >
VTKM_CONT bool operator== (const ArrayHandle< VT, ST > &) const
 
template<typename VT , typename ST >
VTKM_CONT bool operator!= (const ArrayHandle< VT, ST > &) const
 
VTKM_CONT StorageType GetStorage () const
 Get the storage. More...
 
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_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_DEPRECATED (1.6, "Use Allocate(n, vtkm::CopyFlag::On) instead of Shrink(n).") VTKM_CONT void Shrink(vtkm
 
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 VTKM_DEPRECATED (1.6, "PrepareForInput now requires a vtkm::cont::Token object.") ReadPortalType PrepareForInput(vtkm
 
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 (FirstHandleType)
 
 VTKM_IS_ARRAY_HANDLE (SecondHandleType)
 

Additional Inherited Members

- Public Types inherited from vtkm::cont::ArrayHandle< T, StorageTag_ >
using ValueType = T
 
using StorageTag = StorageTag_
 
using StorageType = vtkm::cont::internal::Storage< ValueType, StorageTag >
 
using ReadPortalType = typename StorageType::ReadPortalType
 
using WritePortalType = typename StorageType::WritePortalType
 
using instead = WritePortalType
 
using instead = ReadPortalType
 
- Static Public Member Functions inherited from vtkm::cont::ArrayHandle< T, StorageTag_ >
static constexpr VTKM_CONT vtkm::IdComponent GetNumberOfBuffers ()
 
- Protected Member Functions inherited from vtkm::cont::ArrayHandle< T, StorageTag_ >
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...
 
template<typename BufferContainer >
VTKM_CONT void SetBuffers (const BufferContainer &buffers)
 

Detailed Description

template<typename FirstHandleType, typename SecondHandleType>
class vtkm::cont::ArrayHandleZip< FirstHandleType, SecondHandleType >

ArrayHandleZip is a specialization of ArrayHandle.

It takes two delegate array handle and makes a new handle that access the corresponding entries in these arrays as a pair.

Constructor & Destructor Documentation

◆ ArrayHandleZip()

template<typename FirstHandleType , typename SecondHandleType >
VTKM_CONT vtkm::cont::ArrayHandleZip< FirstHandleType, SecondHandleType >::ArrayHandleZip ( const FirstHandleType &  firstArray,
const SecondHandleType &  secondArray 
)
inline

Member Function Documentation

◆ GetFirstArray()

template<typename FirstHandleType , typename SecondHandleType >
FirstHandleType vtkm::cont::ArrayHandleZip< FirstHandleType, SecondHandleType >::GetFirstArray ( ) const
inline

◆ GetSecondArray()

template<typename FirstHandleType , typename SecondHandleType >
SecondHandleType vtkm::cont::ArrayHandleZip< FirstHandleType, SecondHandleType >::GetSecondArray ( ) const
inline

◆ VTKM_ARRAY_HANDLE_SUBCLASS()

template<typename FirstHandleType , typename SecondHandleType >
vtkm::cont::ArrayHandleZip< FirstHandleType, SecondHandleType >::VTKM_ARRAY_HANDLE_SUBCLASS ( ArrayHandleZip< FirstHandleType, SecondHandleType >  ,
(ArrayHandleZip< FirstHandleType, SecondHandleType >)  ,
(typename internal::ArrayHandleZipTraits< FirstHandleType, SecondHandleType >::Superclass)   
)

◆ VTKM_IS_ARRAY_HANDLE() [1/2]

template<typename FirstHandleType , typename SecondHandleType >
vtkm::cont::ArrayHandleZip< FirstHandleType, SecondHandleType >::VTKM_IS_ARRAY_HANDLE ( FirstHandleType  )
private

◆ VTKM_IS_ARRAY_HANDLE() [2/2]

template<typename FirstHandleType , typename SecondHandleType >
vtkm::cont::ArrayHandleZip< FirstHandleType, SecondHandleType >::VTKM_IS_ARRAY_HANDLE ( SecondHandleType  )
private

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