Basic array storage for an array handle. More...

#include <ArrayHandleBasic.h>

Inheritance diagram for vtkm::cont::ArrayHandleBasic< T >:

Public Types
using	Thisclass = typename vtkm::cont::detail::GetTypeInParentheses< void(ArrayHandleBasic< T >) >::type

using	Superclass = typename vtkm::cont::detail::GetTypeInParentheses< void(ArrayHandle< T, vtkm::cont::StorageTagBasic >) >::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, vtkm::cont::StorageTagBasic >
using	ValueType = T

using	StorageTag = vtkm::cont::StorageTagBasic

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
	ArrayHandleBasic ()

VTKM_CONT	ArrayHandleBasic (const Thisclass &src)

VTKM_CONT	ArrayHandleBasic (Thisclass &&src) noexcept

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

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

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

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

VTKM_CONT Thisclass &	operator= (const Thisclass &src)

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

	ArrayHandleBasic (T *array, vtkm::Id numberOfValues, vtkm::cont::internal::BufferInfo::Deleter deleter, vtkm::cont::internal::BufferInfo::Reallocater reallocater=internal::InvalidRealloc)

	ArrayHandleBasic (T *array, vtkm::Id numberOfValues, vtkm::cont::DeviceAdapterId device, vtkm::cont::internal::BufferInfo::Deleter deleter, vtkm::cont::internal::BufferInfo::Reallocater reallocater=internal::InvalidRealloc)

	ArrayHandleBasic (T array, void container, vtkm::Id numberOfValues, vtkm::cont::internal::BufferInfo::Deleter deleter, vtkm::cont::internal::BufferInfo::Reallocater reallocater=internal::InvalidRealloc)

	ArrayHandleBasic (T array, void container, vtkm::Id numberOfValues, vtkm::cont::DeviceAdapterId device, vtkm::cont::internal::BufferInfo::Deleter deleter, vtkm::cont::internal::BufferInfo::Reallocater reallocater=internal::InvalidRealloc)

const T *	GetReadPointer () const
	Gets raw access to the `ArrayHandle`'s data. More...

const T *	GetReadPointer (vtkm::cont::Token &token) const
	Gets raw access to the `ArrayHandle`'s data. More...

T *	GetWritePointer () const
	Gets raw write access to the `ArrayHandle`'s data. More...

T *	GetWritePointer (vtkm::cont::Token &token) const
	Gets raw write access to the `ArrayHandle`'s data. More...

const T *	GetReadPointer (vtkm::cont::DeviceAdapterId device) const
	Gets raw access to the `ArrayHandle`'s data on a particular device. More...

const T *	GetReadPointer (vtkm::cont::DeviceAdapterId device, vtkm::cont::Token &token) const
	Gets raw access to the `ArrayHandle`'s data. More...

T *	GetWritePointer (vtkm::cont::DeviceAdapterId device) const
	Gets raw write access to the `ArrayHandle`'s data. More...

T *	GetWritePointer (vtkm::cont::DeviceAdapterId device, vtkm::cont::Token &token) const
	Gets raw write access to the `ArrayHandle`'s data. More...

Public Member Functions inherited from vtkm::cont::ArrayHandle< T, vtkm::cont::StorageTagBasic >
	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< VT, ST > &) const

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

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, vtkm::cont::StorageTagBasic >
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 T>
class vtkm::cont::ArrayHandleBasic< T >

Basic array storage for an array handle.

This array handle references a standard C array. It provides a level of safety and management across devices. This is the default used when no storage is specified. Using this subclass allows access to the underlying raw array.

Member Typedef Documentation

◆ ReadPortalType

template<typename T >

using vtkm::cont::ArrayHandleBasic< T >::ReadPortalType = typename Superclass::ReadPortalType

◆ StorageTag

template<typename T >

using vtkm::cont::ArrayHandleBasic< T >::StorageTag = typename Superclass::StorageTag

◆ StorageType

template<typename T >

using vtkm::cont::ArrayHandleBasic< T >::StorageType = typename Superclass::StorageType

◆ Superclass

template<typename T >

using vtkm::cont::ArrayHandleBasic< T >::Superclass = typename vtkm::cont::detail::GetTypeInParentheses<void (ArrayHandle<T, vtkm::cont::StorageTagBasic>) >::type

◆ Thisclass

template<typename T >

using vtkm::cont::ArrayHandleBasic< T >::Thisclass = typename vtkm::cont::detail::GetTypeInParentheses<void (ArrayHandleBasic<T>) >::type

◆ ValueType

template<typename T >

using vtkm::cont::ArrayHandleBasic< T >::ValueType = typename Superclass::ValueType

◆ WritePortalType

template<typename T >

using vtkm::cont::ArrayHandleBasic< T >::WritePortalType = typename Superclass::WritePortalType

Constructor & Destructor Documentation

◆ ArrayHandleBasic() [1/11]

template<typename T >

vtkm::cont::ArrayHandleBasic< T >::ArrayHandleBasic ( )

inline

◆ ArrayHandleBasic() [2/11]

template<typename T >

VTKM_CONT vtkm::cont::ArrayHandleBasic< T >::ArrayHandleBasic ( const Thisclass & src )

inline

◆ ArrayHandleBasic() [3/11]

template<typename T >

VTKM_CONT vtkm::cont::ArrayHandleBasic< T >::ArrayHandleBasic ( Thisclass && src )

inlinenoexcept

◆ ArrayHandleBasic() [4/11]

template<typename T >

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

inline

◆ ArrayHandleBasic() [5/11]

template<typename T >

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

inlinenoexcept

◆ ArrayHandleBasic() [6/11]

template<typename T >

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

inlineexplicit

◆ ArrayHandleBasic() [7/11]

template<typename T >

VTKM_CONT vtkm::cont::ArrayHandleBasic< T >::ArrayHandleBasic ( std::vector< vtkm::cont::internal::Buffer > && buffers )

inlineexplicitnoexcept

◆ ArrayHandleBasic() [8/11]

template<typename T >

vtkm::cont::ArrayHandleBasic< T >::ArrayHandleBasic	(	T *	array,
		vtkm::Id	numberOfValues,
		vtkm::cont::internal::BufferInfo::Deleter	deleter,
		vtkm::cont::internal::BufferInfo::Reallocater	reallocater = `internal::InvalidRealloc`
	)

inline

◆ ArrayHandleBasic() [9/11]

template<typename T >

vtkm::cont::ArrayHandleBasic< T >::ArrayHandleBasic	(	T *	array,
		vtkm::Id	numberOfValues,
		vtkm::cont::DeviceAdapterId	device,
		vtkm::cont::internal::BufferInfo::Deleter	deleter,
		vtkm::cont::internal::BufferInfo::Reallocater	reallocater = `internal::InvalidRealloc`
	)

inline

◆ ArrayHandleBasic() [10/11]

template<typename T >

vtkm::cont::ArrayHandleBasic< T >::ArrayHandleBasic	(	T *	array,
		void *	container,
		vtkm::Id	numberOfValues,
		vtkm::cont::internal::BufferInfo::Deleter	deleter,
		vtkm::cont::internal::BufferInfo::Reallocater	reallocater = `internal::InvalidRealloc`
	)

inline

◆ ArrayHandleBasic() [11/11]

template<typename T >

vtkm::cont::ArrayHandleBasic< T >::ArrayHandleBasic	(	T *	array,
		void *	container,
		vtkm::Id	numberOfValues,
		vtkm::cont::DeviceAdapterId	device,
		vtkm::cont::internal::BufferInfo::Deleter	deleter,
		vtkm::cont::internal::BufferInfo::Reallocater	reallocater = `internal::InvalidRealloc`
	)

inline

Member Function Documentation

◆ GetReadPointer() [1/4]

template<typename T >

const T* vtkm::cont::ArrayHandleBasic< T >::GetReadPointer ( ) const

inline

Gets raw access to the ArrayHandle's data.

Note that the returned array may become invalidated by other operations on the ArryHandle.

◆ GetReadPointer() [2/4]

template<typename T >

const T* vtkm::cont::ArrayHandleBasic< T >::GetReadPointer ( vtkm::cont::DeviceAdapterId device ) const

inline

Gets raw access to the ArrayHandle's data on a particular device.

Note that the returned array may become invalidated by other operations on the ArryHandle.

Parameters

device The device ID or device tag specifying on which device the array will be valid on.

◆ GetReadPointer() [3/4]

template<typename T >

const T* vtkm::cont::ArrayHandleBasic< T >::GetReadPointer	(	vtkm::cont::DeviceAdapterId	device,
		vtkm::cont::Token &	token
	)		const

inline

Gets raw access to the ArrayHandle's data.

Parameters

device	The device ID or device tag specifying on which device the array will be valid on.
token	When a `vtkm::cont::Token` is provided, the array is locked from being used by any write operations until the token goes out of scope.

◆ GetReadPointer() [4/4]

template<typename T >

const T* vtkm::cont::ArrayHandleBasic< T >::GetReadPointer ( vtkm::cont::Token & token ) const

inline

Gets raw access to the ArrayHandle's data.

Parameters

token When a vtkm::cont::Token is provided, the array is locked from being used by any write operations until the token goes out of scope.

◆ GetWritePointer() [1/4]

template<typename T >

T* vtkm::cont::ArrayHandleBasic< T >::GetWritePointer ( ) const

inline

Gets raw write access to the ArrayHandle's data.

Note that the returned array may become invalidated by other operations on the ArryHandle.

◆ GetWritePointer() [2/4]

template<typename T >

T* vtkm::cont::ArrayHandleBasic< T >::GetWritePointer ( vtkm::cont::DeviceAdapterId device ) const

inline

Gets raw write access to the ArrayHandle's data.

Note that the returned array may become invalidated by other operations on the ArryHandle.

Parameters

device The device ID or device tag specifying on which device the array will be valid on.

◆ GetWritePointer() [3/4]

template<typename T >

T* vtkm::cont::ArrayHandleBasic< T >::GetWritePointer	(	vtkm::cont::DeviceAdapterId	device,
		vtkm::cont::Token &	token
	)		const

inline

Gets raw write access to the ArrayHandle's data.

Parameters

device	The device ID or device tag specifying on which device the array will be valid on.
token	When a `vtkm::cont::Token` is provided, the array is locked from being used by any read or write operations until the token goes out of scope.

◆ GetWritePointer() [4/4]

template<typename T >

T* vtkm::cont::ArrayHandleBasic< T >::GetWritePointer ( vtkm::cont::Token & token ) const

inline

Gets raw write access to the ArrayHandle's data.

Parameters

token When a vtkm::cont::Token is provided, the array is locked from being used by any read or write operations until the token goes out of scope.

◆ operator=() [1/2]

template<typename T >

VTKM_CONT Thisclass& vtkm::cont::ArrayHandleBasic< T >::operator= ( const Thisclass & src )

inline

◆ operator=() [2/2]

template<typename T >

VTKM_CONT Thisclass& vtkm::cont::ArrayHandleBasic< T >::operator= ( Thisclass && src )

inlinenoexcept

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

ArrayHandleBasic.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename T> class vtkm::cont::ArrayHandleBasic< T >

Member Typedef Documentation

◆ ReadPortalType

◆ StorageTag

◆ StorageType

◆ Superclass

◆ Thisclass

◆ ValueType

◆ WritePortalType

Constructor & Destructor Documentation

◆ ArrayHandleBasic() [1/11]

◆ ArrayHandleBasic() [2/11]

◆ ArrayHandleBasic() [3/11]

◆ ArrayHandleBasic() [4/11]

◆ ArrayHandleBasic() [5/11]

◆ ArrayHandleBasic() [6/11]

◆ ArrayHandleBasic() [7/11]

◆ ArrayHandleBasic() [8/11]

◆ ArrayHandleBasic() [9/11]

◆ ArrayHandleBasic() [10/11]

◆ ArrayHandleBasic() [11/11]

Member Function Documentation

◆ GetReadPointer() [1/4]

◆ GetReadPointer() [2/4]

◆ GetReadPointer() [3/4]

◆ GetReadPointer() [4/4]

◆ GetWritePointer() [1/4]

◆ GetWritePointer() [2/4]

◆ GetWritePointer() [3/4]

◆ GetWritePointer() [4/4]

◆ operator=() [1/2]

◆ operator=() [2/2]

template<typename T>
class vtkm::cont::ArrayHandleBasic< T >