ArrayHandleCartesianProduct is a specialization of ArrayHandle. More...

#include <ArrayHandleCartesianProduct.h>

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

Public Types
using	Thisclass = typename vtkm::cont::detail::GetTypeInParentheses< void(ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >) >::type

using	Superclass = typename vtkm::cont::detail::GetTypeInParentheses< void(typename internal::ArrayHandleCartesianProductTraits< FirstHandleType, SecondHandleType, ThirdHandleType >::Superclass) >::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 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
	The type of portal used when accessing data in a read-only mode. More...

using	WritePortalType = typename StorageType::WritePortalType
	The type of portal used when accessing data in a read-write mode. More...

Public Member Functions
	ArrayHandleCartesianProduct ()

VTKM_CONT	ArrayHandleCartesianProduct (const Thisclass &src)

VTKM_CONT	ArrayHandleCartesianProduct (Thisclass &&src) noexcept

VTKM_CONT	ArrayHandleCartesianProduct (const vtkm::cont::ArrayHandle< typename Superclass::ValueType, typename Superclass::StorageTag > &src)

VTKM_CONT	ArrayHandleCartesianProduct (vtkm::cont::ArrayHandle< typename Superclass::ValueType, typename Superclass::StorageTag > &&src) noexcept

VTKM_CONT	ArrayHandleCartesianProduct (const std::vector< vtkm::cont::internal::Buffer > &buffers)

VTKM_CONT	ArrayHandleCartesianProduct (std::vector< vtkm::cont::internal::Buffer > &&buffers) noexcept

VTKM_CONT Thisclass &	operator= (const Thisclass &src)

VTKM_CONT Thisclass &	operator= (Thisclass &&src) noexcept

	ArrayHandleCartesianProduct (const FirstHandleType &firstArray, const SecondHandleType &secondArray, const ThirdHandleType &thirdArray)
	Construct an `ArrayHandleCartesianProduct` given arrays for the coordinates in the x, y, and z diretions. More...

	~ArrayHandleCartesianProduct ()
	Implemented so that it is defined exclusively in the control environment. More...

FirstHandleType	GetFirstArray () const
	Get the array for the coordinates in the x direction. More...

SecondHandleType	GetSecondArray () const
	Get the array for the coordinates in the y direction. More...

ThirdHandleType	GetThirdArray () const
	Get the array for the coordinates in the z direction. More...

Public Member Functions inherited from vtkm::cont::ArrayHandle< T, StorageTag_ >
	ArrayHandle ()
	Constructs an empty ArrayHandle. More...

	ArrayHandle (const vtkm::cont::ArrayHandle< ValueType, StorageTag > &src)
	Copy constructor. More...

	ArrayHandle (vtkm::cont::ArrayHandle< ValueType, StorageTag > &&src) noexcept
	Move constructor. More...

	ArrayHandle (const std::vector< vtkm::cont::internal::Buffer > &buffers)
	Special constructor for subclass specializations that need to set the initial state array. More...

	ArrayHandle (std::vector< vtkm::cont::internal::Buffer > &&buffers) noexcept
	Special constructor for subclass specializations that need to set the initial state array. More...

	~ArrayHandle ()
	Destructs an empty ArrayHandle. More...

vtkm::cont::ArrayHandle< ValueType, StorageTag > &	operator= (const vtkm::cont::ArrayHandle< ValueType, StorageTag > &src)
	Shallow copies an ArrayHandle. More...

vtkm::cont::ArrayHandle< ValueType, StorageTag > &	operator= (vtkm::cont::ArrayHandle< ValueType, StorageTag > &&src) noexcept
	Move and Assignment of an ArrayHandle. More...

bool	operator== (const ArrayHandle< ValueType, StorageTag > &rhs) const
	Like a pointer, two `ArrayHandle`s are considered equal if they point to the same location in memory. More...

bool	operator!= (const ArrayHandle< ValueType, StorageTag > &rhs) const

template<typename VT , typename ST >
bool	operator== (const ArrayHandle< VT, ST > &) const

template<typename VT , typename ST >
bool	operator!= (const ArrayHandle< VT, ST > &) const

StorageType	GetStorage () const
	Get the storage. More...

ReadPortalType	ReadPortal () const
	Get an array portal that can be used in the control environment. More...

ReadPortalType	ReadPortal (vtkm::cont::Token &token) const
	The type of portal used when accessing data in a read-only mode. More...

WritePortalType	WritePortal () const
	Get an array portal that can be used in the control environment. More...

WritePortalType	WritePortal (vtkm::cont::Token &token) const
	Get an array portal that can be used in the control environment. More...

vtkm::Id	GetNumberOfValues () const
	Returns the number of entries in the array. More...

vtkm::IdComponent	GetNumberOfComponentsFlat () const
	Returns the total number of components for each value in the array. More...

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

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

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

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

void	Fill (const ValueType &fillValue, vtkm::Id startIndex, vtkm::Id endIndex, vtkm::cont::Token &token) const
	Fills the array with a given value. More...

void	Fill (const ValueType &fillValue, vtkm::Id startIndex, vtkm::Id endIndex) const
	Fills the array with a given value. More...

void	Fill (const ValueType &fillValue, vtkm::Id startIndex=0) const
	Fills the array with a given value. More...

void	ReleaseResourcesExecution () const
	Releases any resources being used in the execution environment (that are not being shared by the control environment). More...

void	ReleaseResources () const
	Releases all resources in both the control and execution environments. More...

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

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

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

bool	IsOnDevice (vtkm::cont::DeviceAdapterId device) const
	Returns true if the ArrayHandle's data is on the given device. More...

bool	IsOnHost () const
	Returns true if the ArrayHandle's data is on the host. More...

void	SyncControlArray () const
	Synchronizes the control array with the execution array. More...

void	Enqueue (const vtkm::cont::Token &token) const
	Enqueue a token for access to this ArrayHandle. More...

void	DeepCopyFrom (const vtkm::cont::ArrayHandle< ValueType, StorageTag > &source) const
	Deep copies the data in the array. More...

const std::vector< vtkm::cont::internal::Buffer > &	GetBuffers () const
	Returns the internal `Buffer` structures that hold the data. More...

std::vector< vtkm::cont::internal::Buffer > &	GetBuffers ()

Additional Inherited Members
Protected Member Functions inherited from vtkm::cont::ArrayHandle< T, StorageTag_ >
void	SetBuffer (vtkm::IdComponent index, const vtkm::cont::internal::Buffer &buffer)

void	SetBuffers (const std::vector< vtkm::cont::internal::Buffer > &buffers)

void	SetBuffers (std::vector< vtkm::cont::internal::Buffer > &&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

◆ ReadPortalType

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

using vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::ReadPortalType = typename Superclass::ReadPortalType

◆ StorageTag

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

using vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::StorageTag = typename Superclass::StorageTag

◆ StorageType

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

using vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::StorageType = typename Superclass::StorageType

◆ Superclass

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

using vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::Superclass = typename vtkm::cont::detail::GetTypeInParentheses<void (typename internal::ArrayHandleCartesianProductTraits<FirstHandleType, SecondHandleType, ThirdHandleType>::Superclass) >::type

◆ Thisclass

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

using vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::Thisclass = typename vtkm::cont::detail::GetTypeInParentheses<void (ArrayHandleCartesianProduct<FirstHandleType, SecondHandleType, ThirdHandleType>) >::type

◆ ValueType

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

using vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::ValueType = typename Superclass::ValueType

◆ WritePortalType

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

using vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::WritePortalType = typename Superclass::WritePortalType

Constructor & Destructor Documentation

◆ ArrayHandleCartesianProduct() [1/8]

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::ArrayHandleCartesianProduct ( )

inline

◆ ArrayHandleCartesianProduct() [2/8]

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

VTKM_CONT vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::ArrayHandleCartesianProduct ( const Thisclass & src )

inline

◆ ArrayHandleCartesianProduct() [3/8]

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

VTKM_CONT vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::ArrayHandleCartesianProduct ( Thisclass && src )

inlinenoexcept

◆ ArrayHandleCartesianProduct() [4/8]

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

VTKM_CONT vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::ArrayHandleCartesianProduct ( const vtkm::cont::ArrayHandle< typename Superclass::ValueType, typename Superclass::StorageTag > & src )

inline

◆ ArrayHandleCartesianProduct() [5/8]

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

VTKM_CONT vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::ArrayHandleCartesianProduct ( vtkm::cont::ArrayHandle< typename Superclass::ValueType, typename Superclass::StorageTag > && src )

inlinenoexcept

◆ ArrayHandleCartesianProduct() [6/8]

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

VTKM_CONT vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::ArrayHandleCartesianProduct ( const std::vector< vtkm::cont::internal::Buffer > & buffers )

inlineexplicit

◆ ArrayHandleCartesianProduct() [7/8]

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

VTKM_CONT vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::ArrayHandleCartesianProduct ( std::vector< vtkm::cont::internal::Buffer > && buffers )

inlineexplicitnoexcept

◆ ArrayHandleCartesianProduct() [8/8]

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

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

inline

Construct an ArrayHandleCartesianProduct given arrays for the coordinates in the x, y, and z diretions.

◆ ~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 >

FirstHandleType vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::GetFirstArray ( ) const

inline

Get the array for the coordinates in the x direction.

◆ GetSecondArray()

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

SecondHandleType vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::GetSecondArray ( ) const

inline

Get the array for the coordinates in the y direction.

◆ GetThirdArray()

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

ThirdHandleType vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::GetThirdArray ( ) const

inline

Get the array for the coordinates in the z direction.

◆ operator=() [1/2]

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

VTKM_CONT Thisclass& vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::operator= ( const Thisclass & src )

inline

◆ operator=() [2/2]

template<typename FirstHandleType , typename SecondHandleType , typename ThirdHandleType >

VTKM_CONT Thisclass& vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >::operator= ( Thisclass && src )

inlinenoexcept

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

ArrayHandleCartesianProduct.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename FirstHandleType, typename SecondHandleType, typename ThirdHandleType> class vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >

Member Typedef Documentation

◆ ReadPortalType

◆ StorageTag

◆ StorageType

◆ Superclass

◆ Thisclass

◆ ValueType

◆ WritePortalType

Constructor & Destructor Documentation

◆ ArrayHandleCartesianProduct() [1/8]

◆ ArrayHandleCartesianProduct() [2/8]

◆ ArrayHandleCartesianProduct() [3/8]

◆ ArrayHandleCartesianProduct() [4/8]

◆ ArrayHandleCartesianProduct() [5/8]

◆ ArrayHandleCartesianProduct() [6/8]

◆ ArrayHandleCartesianProduct() [7/8]

◆ ArrayHandleCartesianProduct() [8/8]

◆ ~ArrayHandleCartesianProduct()

Member Function Documentation

◆ GetFirstArray()

◆ GetSecondArray()

◆ GetThirdArray()

◆ operator=() [1/2]

◆ operator=() [2/2]

template<typename FirstHandleType, typename SecondHandleType, typename ThirdHandleType>
class vtkm::cont::ArrayHandleCartesianProduct< FirstHandleType, SecondHandleType, ThirdHandleType >