Provided a windowed view into a vtkm::cont::ArrayHandle. More...

#include <ArrayHandleView.h>

Inheritance diagram for vtkm::cont::ArrayHandleView< ArrayHandleType >:

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

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

using	StorageTag = StorageTagView< ArrayHandleType::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
	ArrayHandleView ()

VTKM_CONT	ArrayHandleView (const Thisclass &src)

VTKM_CONT	ArrayHandleView (Thisclass &&src) noexcept

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

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

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

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

VTKM_CONT Thisclass &	operator= (const Thisclass &src)

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

	ArrayHandleView (const ArrayHandleType &array, vtkm::Id startIndex, vtkm::Id numValues)
	Create an `ArrayHandleView` over a provided source array. More...

ArrayHandleType	GetSourceArray () const
	Retrieve the full array being viewed. More...

vtkm::Id	GetStartIndex () const
	Retrieve the start index from the array being viewed. More...

Public Member Functions inherited from vtkm::cont::ArrayHandle< ArrayHandleType::ValueType, StorageTagView< ArrayHandleType::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< 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< ArrayHandleType::ValueType, StorageTagView< ArrayHandleType::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 ArrayHandleType>
class vtkm::cont::ArrayHandleView< ArrayHandleType >

Provided a windowed view into a vtkm::cont::ArrayHandle.

ArrayHandleView is a fancy array that wraps around another ArrayHandle and reindexes it to provide access to a specified region of values in the array. This view is specified using the offset to the first index and the length of the entries to view.

Member Typedef Documentation

◆ ReadPortalType

template<typename ArrayHandleType >

using vtkm::cont::ArrayHandleView< ArrayHandleType >::ReadPortalType = typename Superclass::ReadPortalType

◆ StorageTag

template<typename ArrayHandleType >

using vtkm::cont::ArrayHandleView< ArrayHandleType >::StorageTag = typename Superclass::StorageTag

◆ StorageType

template<typename ArrayHandleType >

using vtkm::cont::ArrayHandleView< ArrayHandleType >::StorageType = typename Superclass::StorageType

◆ Superclass

template<typename ArrayHandleType >

using vtkm::cont::ArrayHandleView< ArrayHandleType >::Superclass = typename vtkm::cont::detail::GetTypeInParentheses<void (vtkm::cont::ArrayHandle<typename ArrayHandleType::ValueType, StorageTagView<typename ArrayHandleType::StorageTag> >) >::type

◆ Thisclass

template<typename ArrayHandleType >

using vtkm::cont::ArrayHandleView< ArrayHandleType >::Thisclass = typename vtkm::cont::detail::GetTypeInParentheses<void (ArrayHandleView<ArrayHandleType>) >::type

◆ ValueType

template<typename ArrayHandleType >

using vtkm::cont::ArrayHandleView< ArrayHandleType >::ValueType = typename Superclass::ValueType

◆ WritePortalType

template<typename ArrayHandleType >

using vtkm::cont::ArrayHandleView< ArrayHandleType >::WritePortalType = typename Superclass::WritePortalType

Constructor & Destructor Documentation

◆ ArrayHandleView() [1/8]

template<typename ArrayHandleType >

vtkm::cont::ArrayHandleView< ArrayHandleType >::ArrayHandleView ( )

inline

◆ ArrayHandleView() [2/8]

template<typename ArrayHandleType >

VTKM_CONT vtkm::cont::ArrayHandleView< ArrayHandleType >::ArrayHandleView ( const Thisclass & src )

inline

◆ ArrayHandleView() [3/8]

template<typename ArrayHandleType >

VTKM_CONT vtkm::cont::ArrayHandleView< ArrayHandleType >::ArrayHandleView ( Thisclass && src )

inlinenoexcept

◆ ArrayHandleView() [4/8]

template<typename ArrayHandleType >

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

inline

◆ ArrayHandleView() [5/8]

template<typename ArrayHandleType >

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

inlinenoexcept

◆ ArrayHandleView() [6/8]

template<typename ArrayHandleType >

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

inlineexplicit

◆ ArrayHandleView() [7/8]

template<typename ArrayHandleType >

VTKM_CONT vtkm::cont::ArrayHandleView< ArrayHandleType >::ArrayHandleView ( std::vector< vtkm::cont::internal::Buffer > && buffers )

inlineexplicitnoexcept

◆ ArrayHandleView() [8/8]

template<typename ArrayHandleType >

vtkm::cont::ArrayHandleView< ArrayHandleType >::ArrayHandleView	(	const ArrayHandleType &	array,
		vtkm::Id	startIndex,
		vtkm::Id	numValues
	)

inline

Create an ArrayHandleView over a provided source array.

Parameters

array	The source array to create a view from.
startIndex	The offset in `array` to start the view.
numValues	The number of values in the view.

Member Function Documentation

◆ GetSourceArray()

template<typename ArrayHandleType >

ArrayHandleType vtkm::cont::ArrayHandleView< ArrayHandleType >::GetSourceArray ( ) const

inline

Retrieve the full array being viewed.

◆ GetStartIndex()

template<typename ArrayHandleType >

vtkm::Id vtkm::cont::ArrayHandleView< ArrayHandleType >::GetStartIndex ( ) const

inline

Retrieve the start index from the array being viewed.

(Note, to get the number of values, simply call the GetNumberOfValues method from the superclass.)

◆ operator=() [1/2]

template<typename ArrayHandleType >

VTKM_CONT Thisclass& vtkm::cont::ArrayHandleView< ArrayHandleType >::operator= ( const Thisclass & src )

inline

◆ operator=() [2/2]

template<typename ArrayHandleType >

VTKM_CONT Thisclass& vtkm::cont::ArrayHandleView< ArrayHandleType >::operator= ( Thisclass && src )

inlinenoexcept

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

ArrayHandleView.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename ArrayHandleType> class vtkm::cont::ArrayHandleView< ArrayHandleType >

Member Typedef Documentation

◆ ReadPortalType

◆ StorageTag

◆ StorageType

◆ Superclass

◆ Thisclass

◆ ValueType

◆ WritePortalType

Constructor & Destructor Documentation

◆ ArrayHandleView() [1/8]

◆ ArrayHandleView() [2/8]

◆ ArrayHandleView() [3/8]

◆ ArrayHandleView() [4/8]

◆ ArrayHandleView() [5/8]

◆ ArrayHandleView() [6/8]

◆ ArrayHandleView() [7/8]

◆ ArrayHandleView() [8/8]

Member Function Documentation

◆ GetSourceArray()

◆ GetStartIndex()

◆ operator=() [1/2]

◆ operator=() [2/2]

template<typename ArrayHandleType>
class vtkm::cont::ArrayHandleView< ArrayHandleType >