VTK-m  1.8
Public Member Functions | Private Types | Private Member Functions | List of all members
vtkm::cont::ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType > Class Template Reference

Implicitly permutes the values in an array. More...

#include <ArrayHandlePermutation.h>

Inheritance diagram for vtkm::cont::ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType >:
vtkm::cont::ArrayHandle< ValueArrayHandleType::ValueType, vtkm::cont::StorageTagPermutation< IndexArrayHandleType::StorageTag, ValueArrayHandleType::StorageTag > >

Public Member Functions

 VTKM_ARRAY_HANDLE_SUBCLASS (ArrayHandlePermutation,(ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType >),(vtkm::cont::ArrayHandle< typename ValueArrayHandleType::ValueType, vtkm::cont::StorageTagPermutation< typename IndexArrayHandleType::StorageTag, typename ValueArrayHandleType::StorageTag >>))
 
VTKM_CONT ArrayHandlePermutation (const IndexArrayHandleType &indexArray, const ValueArrayHandleType &valueArray)
 
VTKM_CONT IndexArrayHandleType GetIndexArray () const
 
VTKM_CONT ValueArrayHandleType GetValueArray () const
 
- Public Member Functions inherited from vtkm::cont::ArrayHandle< ValueArrayHandleType::ValueType, vtkm::cont::StorageTagPermutation< IndexArrayHandleType::StorageTag, ValueArrayHandleType::StorageTag > >
struct VTKM_DEPRECATED (1.6, "Use ReadPortalType and WritePortalType.") ExecutionTypes
 
VTKM_CONT VTKM_DEPRECATED (1.6, "Use ArrayHandle::WritePortal() instead. " "Note that the returned portal will lock the array while it is in scope.") VTKM_CONT VTKM_DEPRECATED(1.6
 Get the array portal of the control array. More...
 
 VTKM_DEPRECATED (1.6, "Use Allocate(n, vtkm::CopyFlag::On) instead of Shrink(n).") VTKM_CONT void Shrink(vtkm
 
VTKM_CONT VTKM_DEPRECATED (1.6, "PrepareForInput now requires a vtkm::cont::Token object.") ReadPortalType PrepareForInput(vtkm
 
VTKM_CONT ArrayHandle ()
 Constructs an empty ArrayHandle. More...
 
VTKM_CONT ArrayHandle (const vtkm::cont::ArrayHandle< ValueType, StorageTag > &src)
 Copy constructor. More...
 
VTKM_CONT ArrayHandle (vtkm::cont::ArrayHandle< ValueType, StorageTag > &&src) noexcept
 Move constructor. More...
 
VTKM_CONT ~ArrayHandle ()
 Destructs an empty ArrayHandle. More...
 
VTKM_CONT vtkm::cont::ArrayHandle< ValueType, StorageTag > & operator= (const vtkm::cont::ArrayHandle< ValueType, StorageTag > &src)
 Copies an ArrayHandle. More...
 
VTKM_CONT vtkm::cont::ArrayHandle< ValueType, StorageTag > & operator= (vtkm::cont::ArrayHandle< ValueType, StorageTag > &&src) noexcept
 Move and Assignment of an ArrayHandle. More...
 
VTKM_CONT bool operator== (const ArrayHandle< ValueType, StorageTag > &rhs) const
 Like a pointer, two ArrayHandles are considered equal if they point to the same location in memory. More...
 
VTKM_CONT bool operator== (const ArrayHandle< VT, ST > &) const
 
VTKM_CONT bool operator!= (const ArrayHandle< ValueType, StorageTag > &rhs) const
 
VTKM_CONT bool operator!= (const ArrayHandle< VT, ST > &) const
 
VTKM_CONT StorageType GetStorage () const
 Get the storage. More...
 
VTKM_CONT Use ArrayHandle::ReadPortal () instead. " "Note that the returned portal will lock the array while it is in scope.") VTKM_CONT ReadPortalType ReadPortal() const
 Get an array portal that can be used in the control environment. More...
 
VTKM_CONT WritePortalType WritePortal () const
 Get an array portal that can be used in the control environment. More...
 
VTKM_CONT vtkm::Id GetNumberOfValues () const
 Returns the number of entries in the array. More...
 
VTKM_CONT void ReleaseResourcesExecution () const
 Releases any resources being used in the execution environment (that are not being shared by the control environment). More...
 
VTKM_CONT void ReleaseResources () const
 Releases all resources in both the control and execution environments. More...
 
VTKM_CONT 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...
 
VTKM_CONT 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...
 
VTKM_CONT 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...
 
VTKM_CONT ArrayHandle (const std::vector< vtkm::cont::internal::Buffer > &buffers)
 
VTKM_CONT ArrayHandle (std::vector< vtkm::cont::internal::Buffer > &&buffers) noexcept
 
VTKM_CONT ArrayHandle (const vtkm::cont::internal::Buffer *buffers)
 
VTKM_CONT 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...
 
VTKM_CONT 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...
 
VTKM_CONT 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...
 
VTKM_CONT 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...
 
VTKM_CONT void Fill (const ValueType &fillValue, vtkm::Id startIndex, vtkm::Id endIndex, vtkm::cont::Token &token) const
 Fills the array with a given value. More...
 
VTKM_CONT void Fill (const ValueType &fillValue, vtkm::Id startIndex, vtkm::Id endIndex) const
 Fills the array with a given value. More...
 
VTKM_CONT void Fill (const ValueType &fillValue, vtkm::Id startIndex=0) const
 Fills the array with a given value. More...
 

Private Types

using StorageType = vtkm::cont::internal::Storage< ValueType, StorageTag >
 

Private Member Functions

 VTKM_IS_ARRAY_HANDLE (IndexArrayHandleType)
 
 VTKM_IS_ARRAY_HANDLE (ValueArrayHandleType)
 
 VTKM_STATIC_ASSERT_MSG ((std::is_same< vtkm::Id, typename IndexArrayHandleType::ValueType >::value), "Permutation array in ArrayHandlePermutation must have vtkm::Id value type.")
 

Additional Inherited Members

- Public Types inherited from vtkm::cont::ArrayHandle< ValueArrayHandleType::ValueType, vtkm::cont::StorageTagPermutation< IndexArrayHandleType::StorageTag, ValueArrayHandleType::StorageTag > >
using ValueType = ValueArrayHandleType::ValueType
 
using StorageTag = vtkm::cont::StorageTagPermutation< IndexArrayHandleType::StorageTag, ValueArrayHandleType::StorageTag >
 
using StorageType = vtkm::cont::internal::Storage< ValueType, StorageTag >
 
using ReadPortalType = typename StorageType::ReadPortalType
 
using WritePortalType = typename StorageType::WritePortalType
 
using instead = WritePortalType
 
using instead = ReadPortalType
 
- Static Public Member Functions inherited from vtkm::cont::ArrayHandle< ValueArrayHandleType::ValueType, vtkm::cont::StorageTagPermutation< IndexArrayHandleType::StorageTag, ValueArrayHandleType::StorageTag > >
static constexpr VTKM_CONT vtkm::IdComponent GetNumberOfBuffers ()
 
- Protected Member Functions inherited from vtkm::cont::ArrayHandle< ValueArrayHandleType::ValueType, vtkm::cont::StorageTagPermutation< IndexArrayHandleType::StorageTag, ValueArrayHandleType::StorageTag > >
VTKM_CONT void SetBuffer (vtkm::IdComponent index, const vtkm::cont::internal::Buffer &buffer)
 Returns true if the ArrayHandle's data is on the given device. More...
 
VTKM_CONT void SetBuffers (const BufferContainer &buffers)
 

Detailed Description

template<typename IndexArrayHandleType, typename ValueArrayHandleType>
class vtkm::cont::ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType >

Implicitly permutes the values in an array.

ArrayHandlePermutation is a specialization of ArrayHandle. It takes two delegate array handles: an array of indices and an array of values. The array handle created contains the values given permuted by the indices given. So for a given index i, ArrayHandlePermutation looks up the i-th value in the index array to get permuted index j and then gets the j-th value in the value array. This index permutation is done on the fly rather than creating a copy of the array.

An ArrayHandlePermutation can be used for either input or output. However, if used for output the array must be pre-allocated. That is, the indices must already be established and the values must have an allocation large enough to accommodate the indices. An output ArrayHandlePermutation will only have values changed. The indices are never changed.

When using ArrayHandlePermutation great care should be taken to make sure that every index in the index array points to a valid position in the value array. Otherwise, access validations will occur. Also, be wary of duplicate indices that point to the same location in the value array. For input arrays, this is fine. However, this could result in unexpected results for using as output and is almost certainly wrong for using as in-place.

Member Typedef Documentation

◆ StorageType

template<typename IndexArrayHandleType , typename ValueArrayHandleType >
using vtkm::cont::ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType >::StorageType = vtkm::cont::internal::Storage<ValueType, StorageTag>
private

Constructor & Destructor Documentation

◆ ArrayHandlePermutation()

template<typename IndexArrayHandleType , typename ValueArrayHandleType >
VTKM_CONT vtkm::cont::ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType >::ArrayHandlePermutation ( const IndexArrayHandleType &  indexArray,
const ValueArrayHandleType &  valueArray 
)
inline

Member Function Documentation

◆ GetIndexArray()

template<typename IndexArrayHandleType , typename ValueArrayHandleType >
VTKM_CONT IndexArrayHandleType vtkm::cont::ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType >::GetIndexArray ( ) const
inline

◆ GetValueArray()

template<typename IndexArrayHandleType , typename ValueArrayHandleType >
VTKM_CONT ValueArrayHandleType vtkm::cont::ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType >::GetValueArray ( ) const
inline

◆ VTKM_ARRAY_HANDLE_SUBCLASS()

template<typename IndexArrayHandleType , typename ValueArrayHandleType >
vtkm::cont::ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType >::VTKM_ARRAY_HANDLE_SUBCLASS ( ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType >  ,
(ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType >)  ,
(vtkm::cont::ArrayHandle< typename ValueArrayHandleType::ValueType, vtkm::cont::StorageTagPermutation< typename IndexArrayHandleType::StorageTag, typename ValueArrayHandleType::StorageTag >>)   
)

◆ VTKM_IS_ARRAY_HANDLE() [1/2]

template<typename IndexArrayHandleType , typename ValueArrayHandleType >
vtkm::cont::ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType >::VTKM_IS_ARRAY_HANDLE ( IndexArrayHandleType  )
private

◆ VTKM_IS_ARRAY_HANDLE() [2/2]

template<typename IndexArrayHandleType , typename ValueArrayHandleType >
vtkm::cont::ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType >::VTKM_IS_ARRAY_HANDLE ( ValueArrayHandleType  )
private

◆ VTKM_STATIC_ASSERT_MSG()

template<typename IndexArrayHandleType , typename ValueArrayHandleType >
vtkm::cont::ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType >::VTKM_STATIC_ASSERT_MSG ( (std::is_same< vtkm::Id, typename IndexArrayHandleType::ValueType >::value)  ,
"Permutation array in ArrayHandlePermutation< IndexArrayHandleType, ValueArrayHandleType > must have vtkm::Id value type."   
)
private

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