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

ArrayHandleCartesianProduct is a specialization of ArrayHandle. More...

#include <ArrayHandleCartesianProduct.h>

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

Public Member Functions

 VTKM_ARRAY_HANDLE_SUBCLASS (ArrayHandleCartesianProduct,(ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >),(typename internal::ArrayHandleCartesianProductTraits< FirstHandleType, SecondHandleType, ThirdHandleType >::Superclass))
 
VTKM_CONT ArrayHandleCartesianProduct (const FirstHandleType &firstArray, const SecondHandleType &secondArray, const ThirdHandleType &thirdArray)
 
 ~ArrayHandleCartesianProduct ()
 Implemented so that it is defined exclusively in the control environment. More...
 
VTKM_CONT FirstHandleType GetFirstArray () const
 
VTKM_CONT SecondHandleType GetSecondArray () const
 
VTKM_CONT ThirdHandleType GetThirdArray () 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 Types

using StorageType = vtkm::cont::internal::Storage< ValueType, StorageTag >
 

Private Member Functions

 VTKM_IS_ARRAY_HANDLE (FirstHandleType)
 
 VTKM_IS_ARRAY_HANDLE (SecondHandleType)
 
 VTKM_IS_ARRAY_HANDLE (ThirdHandleType)
 

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, typename ThirdHandleType>
class vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >

ArrayHandleCartesianProduct 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.

Member Typedef Documentation

◆ StorageType

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >
using vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::StorageType = vtkm::cont::internal::Storage<ValueType, StorageTag>
private

Constructor & Destructor Documentation

◆ ArrayHandleCartesianProduct()

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

◆ ~ArrayHandleCartesianProduct()

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >
vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::~ArrayHandleCartesianProduct ( )
inline

Implemented so that it is defined exclusively in the control environment.

If there is a separate device for the execution environment (for example, with CUDA), then the automatically generated destructor could be created for all devices, and it would not be valid for all devices.

Member Function Documentation

◆ GetFirstArray()

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >
VTKM_CONT FirstHandleType vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::GetFirstArray ( ) const
inline

◆ GetSecondArray()

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >
VTKM_CONT SecondHandleType vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::GetSecondArray ( ) const
inline

◆ GetThirdArray()

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >
VTKM_CONT ThirdHandleType vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::GetThirdArray ( ) const
inline

◆ VTKM_ARRAY_HANDLE_SUBCLASS()

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >
vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::VTKM_ARRAY_HANDLE_SUBCLASS ( ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >  ,
(ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >)  ,
(typename internal::ArrayHandleCartesianProductTraits< FirstHandleType, SecondHandleType, ThirdHandleType >::Superclass)   
)

◆ VTKM_IS_ARRAY_HANDLE() [1/3]

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

◆ VTKM_IS_ARRAY_HANDLE() [2/3]

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

◆ VTKM_IS_ARRAY_HANDLE() [3/3]

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

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