An ArrayHandle that for Vecs stores each component in a separate physical array. More...

#include <ArrayHandleSOA.h>

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

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

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

using	StorageTag = vtkm::cont::StorageTagSOA

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

VTKM_CONT	ArrayHandleSOA (const Thisclass &src)

VTKM_CONT	ArrayHandleSOA (Thisclass &&src) noexcept

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

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

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

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

VTKM_CONT Thisclass &	operator= (const Thisclass &src)

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

	ArrayHandleSOA (std::initializer_list< vtkm::cont::internal::Buffer > &&componentBuffers)

	ArrayHandleSOA (const std::array< ComponentArrayType, NUM_COMPONENTS > &componentArrays)
	Construct an `ArrayHandleSOA` from a collection of component arrays. More...

	ArrayHandleSOA (const std::vector< ComponentArrayType > &componentArrays)
	Construct an `ArrayHandleSOA` from a collection of component arrays. More...

	ArrayHandleSOA (std::initializer_list< ComponentArrayType > &&componentArrays)
	Construct an `ArrayHandleSOA` from a collection of component arrays. More...

	ArrayHandleSOA (std::initializer_list< std::vector< ComponentType >> &&componentVectors)
	Construct an `ArrayHandleSOA` from a collection of component arrays. More...

template<typename Allocator , typename... RemainingVectors>
	ArrayHandleSOA (vtkm::CopyFlag copy, const std::vector< ComponentType, Allocator > &vector0, RemainingVectors &&... componentVectors)
	Construct an `ArrayHandleSOA` from a collection of component arrays. More...

template<typename... RemainingVectors>
	ArrayHandleSOA (vtkm::CopyFlag copy, std::vector< ComponentType > &&vector0, RemainingVectors &&... componentVectors)
	Construct an `ArrayHandleSOA` from a collection of component arrays. More...

	ArrayHandleSOA (std::initializer_list< const ComponentType * > componentArrays, vtkm::Id length, vtkm::CopyFlag copy)
	Construct an `ArrayHandleSOA` from a collection of component arrays. More...

template<typename... RemainingArrays>
	ArrayHandleSOA (vtkm::Id length, vtkm::CopyFlag copy, const ComponentType *array0, const RemainingArrays &... componentArrays)
	Construct an `ArrayHandleSOA` from a collection of component arrays. More...

vtkm::cont::ArrayHandleBasic< ComponentType >	GetArray (vtkm::IdComponent index) const
	Get a basic array representing the component for the given index. More...

void	SetArray (vtkm::IdComponent index, const ComponentArrayType &array)
	Replace a component array. More...

Public Member Functions inherited from vtkm::cont::ArrayHandle< T, vtkm::cont::StorageTagSOA >
	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 ()

Private Types
using	ComponentType = typename vtkm::VecTraits< T >::ComponentType

using	ComponentArrayType = vtkm::cont::ArrayHandle< ComponentType, vtkm::cont::StorageTagBasic >

Static Private Attributes
static constexpr vtkm::IdComponent	NUM_COMPONENTS = vtkm::VecTraits<T>::NUM_COMPONENTS

Additional Inherited Members
Protected Member Functions inherited from vtkm::cont::ArrayHandle< T, vtkm::cont::StorageTagSOA >
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::ArrayHandleSOA< T >

An ArrayHandle that for Vecs stores each component in a separate physical array.

ArrayHandleSOA behaves like a regular ArrayHandle (with a basic storage) except that if you specify a ValueType of a Vec or a Vec-like, it will actually store each component in a separate physical array. When data are retrieved from the array, they are reconstructed into Vec objects as expected.

The intention of this array type is to help cover the most common ways data is lain out in memory. Typically, arrays of data are either an "array of structures" like the basic storage where you have a single array of structures (like Vec) or a "structure of arrays" where you have an array of a basic type (like float) for each component of the data being represented. The ArrayHandleSOA makes it easy to cover this second case without creating special types.

ArrayHandleSOA can be constructed from a collection of ArrayHandle with basic storage. This allows you to construct Vec arrays from components without deep copies.

Member Typedef Documentation

◆ ComponentArrayType

template<typename T >

using vtkm::cont::ArrayHandleSOA< T >::ComponentArrayType = vtkm::cont::ArrayHandle<ComponentType, vtkm::cont::StorageTagBasic>

private

◆ ComponentType

template<typename T >

using vtkm::cont::ArrayHandleSOA< T >::ComponentType = typename vtkm::VecTraits<T>::ComponentType

private

◆ ReadPortalType

template<typename T >

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

◆ StorageTag

template<typename T >

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

◆ StorageType

template<typename T >

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

◆ Superclass

template<typename T >

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

◆ Thisclass

template<typename T >

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

◆ ValueType

template<typename T >

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

◆ WritePortalType

template<typename T >

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

Constructor & Destructor Documentation

◆ ArrayHandleSOA() [1/16]

template<typename T >

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

inline

◆ ArrayHandleSOA() [2/16]

template<typename T >

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

inline

◆ ArrayHandleSOA() [3/16]

template<typename T >

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

inlinenoexcept

◆ ArrayHandleSOA() [4/16]

template<typename T >

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

inline

◆ ArrayHandleSOA() [5/16]

template<typename T >

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

inlinenoexcept

◆ ArrayHandleSOA() [6/16]

template<typename T >

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

inlineexplicit

◆ ArrayHandleSOA() [7/16]

template<typename T >

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

inlineexplicitnoexcept

◆ ArrayHandleSOA() [8/16]

template<typename T >

vtkm::cont::ArrayHandleSOA< T >::ArrayHandleSOA ( std::initializer_list< vtkm::cont::internal::Buffer > && componentBuffers )

inline

◆ ArrayHandleSOA() [9/16]

template<typename T >

vtkm::cont::ArrayHandleSOA< T >::ArrayHandleSOA ( const std::array< ComponentArrayType, NUM_COMPONENTS > & componentArrays )

inline

Construct an ArrayHandleSOA from a collection of component arrays.

vtkm::cont::ArrayHandle<T> components1;
vtkm::cont::ArrayHandle<T> components2;
vtkm::cont::ArrayHandle<T> components3;
// Fill arrays...
 
std::array<T, 3> allComponents{ components1, components2, components3 };
vtkm::cont::make_ArrayHandleSOA<vtkm::Vec<T, 3>vecarray(allComponents);

◆ ArrayHandleSOA() [10/16]

template<typename T >

vtkm::cont::ArrayHandleSOA< T >::ArrayHandleSOA ( const std::vector< ComponentArrayType > & componentArrays )

inline

Construct an ArrayHandleSOA from a collection of component arrays.

vtkm::cont::ArrayHandle<T> components1;
vtkm::cont::ArrayHandle<T> components2;
vtkm::cont::ArrayHandle<T> components3;
// Fill arrays...
 
std::vector<T> allComponents{ components1, components2, components3 };
vtkm::cont::make_ArrayHandleSOA<vtkm::Vec<T, 3>vecarray(allComponents);

◆ ArrayHandleSOA() [11/16]

template<typename T >

vtkm::cont::ArrayHandleSOA< T >::ArrayHandleSOA ( std::initializer_list< ComponentArrayType > && componentArrays )

inline

Construct an ArrayHandleSOA from a collection of component arrays.

vtkm::cont::ArrayHandle<T> components1;
vtkm::cont::ArrayHandle<T> components2;
vtkm::cont::ArrayHandle<T> components3;
// Fill arrays...
 
vtkm::cont::make_ArrayHandleSOA<vtkm::Vec<T, 3> vecarray(
  { components1, components2, components3 });

◆ ArrayHandleSOA() [12/16]

template<typename T >

vtkm::cont::ArrayHandleSOA< T >::ArrayHandleSOA ( std::initializer_list< std::vector< ComponentType >> && componentVectors )

inline

Construct an ArrayHandleSOA from a collection of component arrays.

The data is copied from the std::vectors to the array handle.

std::vector<T> components1;
std::vector<T> components2;
std::vector<T> components3;
// Fill arrays...
 
vtkm::cont::ArrayHandleSOA<vtkm::Vec<T, 3>> vecarray(
  { components1, components2, components3 });

◆ ArrayHandleSOA() [13/16]

template<typename T >

template<typename Allocator , typename... RemainingVectors>

vtkm::cont::ArrayHandleSOA< T >::ArrayHandleSOA	(	vtkm::CopyFlag	copy,
		const std::vector< ComponentType, Allocator > &	vector0,
		RemainingVectors &&...	componentVectors
	)

inline

Construct an ArrayHandleSOA from a collection of component arrays.

The first argument is a vtkm::CopyFlag to determine whether the input arrays should be copied. The component arrays are listed as arguments. This only works if all the templated arguments are of type std::vector<ComponentType>.

std::vector<T> components1;
std::vector<T> components2;
std::vector<T> components3;
// Fill arrays...
 
vtkm::cont::ArrayHandleSOA<vtkm::Vec<T, 3>> vecarray(
  vtkm::CopyFlag::On, components1, components2, components3);

◆ ArrayHandleSOA() [14/16]

template<typename T >

template<typename... RemainingVectors>

vtkm::cont::ArrayHandleSOA< T >::ArrayHandleSOA	(	vtkm::CopyFlag	copy,
		std::vector< ComponentType > &&	vector0,
		RemainingVectors &&...	componentVectors
	)

inline

Construct an ArrayHandleSOA from a collection of component arrays.

The first argument is a vtkm::CopyFlag to determine whether the input arrays should be copied. The component arrays are listed as arguments. This only works if all the templated arguments are rvalues of type std::vector<ComponentType>.

std::vector<T> components1;
std::vector<T> components2;
std::vector<T> components3;
// Fill arrays...
 
vtkm::cont::ArrayHandleSOA<vtkm::Vec<T, N> vecarray(vtkm::CopyFlag::Off,
                                                    std::move(components1),
                                                    std::move(components2),
                                                    std::move(components3);

◆ ArrayHandleSOA() [15/16]

template<typename T >

vtkm::cont::ArrayHandleSOA< T >::ArrayHandleSOA	(	std::initializer_list< const ComponentType * >	componentArrays,
		vtkm::Id	length,
		vtkm::CopyFlag	copy
	)

inline

Construct an ArrayHandleSOA from a collection of component arrays.

T* components1;
T* components2;
T* components3;
// Fill arrays...
 
vtkm::cont::ArrayHandleSOA<vtkm::Vec<T, 3>>(
  { components1, components2, components3 }, size, vtkm::CopyFlag::On);

◆ ArrayHandleSOA() [16/16]

template<typename T >

template<typename... RemainingArrays>

vtkm::cont::ArrayHandleSOA< T >::ArrayHandleSOA	(	vtkm::Id	length,
		vtkm::CopyFlag	copy,
		const ComponentType *	array0,
		const RemainingArrays &...	componentArrays
	)

inline

Construct an ArrayHandleSOA from a collection of component arrays.

The component arrays are listed as arguments. This only works if all the templated arguments are of type ComponentType*.

T* components1;
T* components2;
T* components3;
// Fill arrays...
 
vtkm::cont::ArrayHandleSOA<vtkm::Vec<T, 3>> vecarray(
  size, vtkm::CopyFlag::On, components1, components2, components3);

Member Function Documentation

◆ GetArray()

template<typename T >

vtkm::cont::ArrayHandleBasic<ComponentType> vtkm::cont::ArrayHandleSOA< T >::GetArray ( vtkm::IdComponent index ) const

inline

Get a basic array representing the component for the given index.

◆ operator=() [1/2]

template<typename T >

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

inline

◆ operator=() [2/2]

template<typename T >

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

inlinenoexcept

◆ SetArray()

template<typename T >

void vtkm::cont::ArrayHandleSOA< T >::SetArray	(	vtkm::IdComponent	index,
		const ComponentArrayType &	array
	)

inline

Replace a component array.

Member Data Documentation

◆ NUM_COMPONENTS

template<typename T >

constexpr vtkm::IdComponent vtkm::cont::ArrayHandleSOA< T >::NUM_COMPONENTS = vtkm::VecTraits<T>::NUM_COMPONENTS

staticconstexprprivate

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

ArrayHandleSOA.h

Public Types

Public Member Functions

Private Types

Static Private Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ComponentArrayType

◆ ComponentType

◆ ReadPortalType

◆ StorageTag

◆ StorageType

◆ Superclass

◆ Thisclass

◆ ValueType

◆ WritePortalType

Constructor & Destructor Documentation

◆ ArrayHandleSOA() [1/16]

◆ ArrayHandleSOA() [2/16]

◆ ArrayHandleSOA() [3/16]

◆ ArrayHandleSOA() [4/16]

◆ ArrayHandleSOA() [5/16]

◆ ArrayHandleSOA() [6/16]

◆ ArrayHandleSOA() [7/16]

◆ ArrayHandleSOA() [8/16]

◆ ArrayHandleSOA() [9/16]

◆ ArrayHandleSOA() [10/16]

◆ ArrayHandleSOA() [11/16]

◆ ArrayHandleSOA() [12/16]

◆ ArrayHandleSOA() [13/16]

◆ ArrayHandleSOA() [14/16]

◆ ArrayHandleSOA() [15/16]

◆ ArrayHandleSOA() [16/16]

Member Function Documentation

◆ GetArray()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ SetArray()

Member Data Documentation

◆ NUM_COMPONENTS

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