VTK-m  1.8
Public Member Functions | Private Types | List of all members
vtkm::cont::ArrayHandleCompositeVector< ArrayTs > Class Template Reference

An ArrayHandle that combines components from other arrays. More...

#include <ArrayHandleCompositeVector.h>

Inheritance diagram for vtkm::cont::ArrayHandleCompositeVector< ArrayTs >:
vtkm::cont::ArrayHandle< internal::CompositeVectorTraits< ArrayTs... >::ValueType, internal::CompositeVectorTraits< ArrayTs... >::StorageTag >

Public Member Functions

 VTKM_ARRAY_HANDLE_SUBCLASS (ArrayHandleCompositeVector,(ArrayHandleCompositeVector< ArrayTs... >),(typename Traits::Superclass))
 
VTKM_CONT ArrayHandleCompositeVector (const ArrayTs &... arrays)
 
VTKM_CONT vtkm::Tuple< ArrayTs... > GetArrayTuple () const
 

Private Types

using Traits = internal::CompositeVectorTraits< ArrayTs... >
 
using StorageType = typename Traits::StorageType
 

Detailed Description

template<typename... ArrayTs>
class vtkm::cont::ArrayHandleCompositeVector< ArrayTs >

An ArrayHandle that combines components from other arrays.

ArrayHandleCompositeVector is a specialization of ArrayHandle that derives its content from other arrays. It takes any number of single-component ArrayHandle objects and mimics an array that contains vectors with components that come from these delegate arrays.

The easiest way to create and type an ArrayHandleCompositeVector is to use the make_ArrayHandleCompositeVector functions.

The ArrayHandleExtractComponent class may be helpful when a desired component is part of an ArrayHandle with a vtkm::Vec ValueType.

Member Typedef Documentation

◆ StorageType

template<typename... ArrayTs>
using vtkm::cont::ArrayHandleCompositeVector< ArrayTs >::StorageType = typename Traits::StorageType
private

◆ Traits

template<typename... ArrayTs>
using vtkm::cont::ArrayHandleCompositeVector< ArrayTs >::Traits = internal::CompositeVectorTraits<ArrayTs...>
private

Constructor & Destructor Documentation

◆ ArrayHandleCompositeVector()

template<typename... ArrayTs>
VTKM_CONT vtkm::cont::ArrayHandleCompositeVector< ArrayTs >::ArrayHandleCompositeVector ( const ArrayTs &...  arrays)
inline

Member Function Documentation

◆ GetArrayTuple()

template<typename... ArrayTs>
VTKM_CONT vtkm::Tuple<ArrayTs...> vtkm::cont::ArrayHandleCompositeVector< ArrayTs >::GetArrayTuple ( ) const
inline

◆ VTKM_ARRAY_HANDLE_SUBCLASS()

template<typename... ArrayTs>
vtkm::cont::ArrayHandleCompositeVector< ArrayTs >::VTKM_ARRAY_HANDLE_SUBCLASS ( ArrayHandleCompositeVector< ArrayTs >  ,
(ArrayHandleCompositeVector< ArrayTs... >)  ,
(typename Traits::Superclass  
)

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