VTK-m  2.1
Public Types | Public Member Functions | List of all members
vtkm::cont::ArrayHandleCounting< CountingValueType > Class Template Reference

ArrayHandleCounting is a specialization of ArrayHandle. More...

#include <ArrayHandleCounting.h>

Inheritance diagram for vtkm::cont::ArrayHandleCounting< CountingValueType >:
vtkm::cont::ArrayHandle< CountingValueType, vtkm::cont::StorageTagCounting >

Public Types

using Thisclass = typename vtkm::cont::detail::GetTypeInParentheses< void(ArrayHandleCounting< CountingValueType >) >::type
 
using Superclass = typename vtkm::cont::detail::GetTypeInParentheses< void(vtkm::cont::ArrayHandle< CountingValueType, StorageTagCounting >) >::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< CountingValueType, vtkm::cont::StorageTagCounting >
using ValueType = CountingValueType
 
using StorageTag = vtkm::cont::StorageTagCounting
 
using StorageType = vtkm::cont::internal::Storage< ValueType, StorageTag >
 
using ReadPortalType = typename StorageType::ReadPortalType
 
using WritePortalType = typename StorageType::WritePortalType
 

Public Member Functions

 ArrayHandleCounting ()
 
VTKM_CONT ArrayHandleCounting (const Thisclass &src)
 
VTKM_CONT ArrayHandleCounting (Thisclass &&src) noexcept
 
VTKM_CONT ArrayHandleCounting (const vtkm::cont::ArrayHandle< typename Superclass::ValueType, typename Superclass::StorageTag > &src)
 
VTKM_CONT ArrayHandleCounting (vtkm::cont::ArrayHandle< typename Superclass::ValueType, typename Superclass::StorageTag > &&src) noexcept
 
VTKM_CONT ArrayHandleCounting (const std::vector< vtkm::cont::internal::Buffer > &buffers)
 
VTKM_CONT ArrayHandleCounting (std::vector< vtkm::cont::internal::Buffer > &&buffers) noexcept
 
VTKM_CONT Thisclassoperator= (const Thisclass &src)
 
VTKM_CONT Thisclassoperator= (Thisclass &&src) noexcept
 
 ArrayHandleCounting (CountingValueType start, CountingValueType step, vtkm::Id length)
 
CountingValueType GetStart () const
 
CountingValueType GetStep () const
 
- Public Member Functions inherited from vtkm::cont::ArrayHandle< CountingValueType, vtkm::cont::StorageTagCounting >
 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 ArrayHandles 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
 
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< CountingValueType, vtkm::cont::StorageTagCounting >
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 CountingValueType>
class vtkm::cont::ArrayHandleCounting< CountingValueType >

ArrayHandleCounting is a specialization of ArrayHandle.

By default it contains a increment value, that is increment for each step between zero and the passed in length

Member Typedef Documentation

◆ ReadPortalType

template<typename CountingValueType >
using vtkm::cont::ArrayHandleCounting< CountingValueType >::ReadPortalType = typename Superclass::ReadPortalType

◆ StorageTag

template<typename CountingValueType >
using vtkm::cont::ArrayHandleCounting< CountingValueType >::StorageTag = typename Superclass::StorageTag

◆ StorageType

template<typename CountingValueType >
using vtkm::cont::ArrayHandleCounting< CountingValueType >::StorageType = typename Superclass::StorageType

◆ Superclass

template<typename CountingValueType >
using vtkm::cont::ArrayHandleCounting< CountingValueType >::Superclass = typename vtkm::cont::detail::GetTypeInParentheses<void (vtkm::cont::ArrayHandle<CountingValueType, StorageTagCounting>) >::type

◆ Thisclass

template<typename CountingValueType >
using vtkm::cont::ArrayHandleCounting< CountingValueType >::Thisclass = typename vtkm::cont::detail::GetTypeInParentheses<void (ArrayHandleCounting<CountingValueType>) >::type

◆ ValueType

template<typename CountingValueType >
using vtkm::cont::ArrayHandleCounting< CountingValueType >::ValueType = typename Superclass::ValueType

◆ WritePortalType

template<typename CountingValueType >
using vtkm::cont::ArrayHandleCounting< CountingValueType >::WritePortalType = typename Superclass::WritePortalType

Constructor & Destructor Documentation

◆ ArrayHandleCounting() [1/8]

template<typename CountingValueType >
vtkm::cont::ArrayHandleCounting< CountingValueType >::ArrayHandleCounting ( )
inline

◆ ArrayHandleCounting() [2/8]

template<typename CountingValueType >
VTKM_CONT vtkm::cont::ArrayHandleCounting< CountingValueType >::ArrayHandleCounting ( const Thisclass src)
inline

◆ ArrayHandleCounting() [3/8]

template<typename CountingValueType >
VTKM_CONT vtkm::cont::ArrayHandleCounting< CountingValueType >::ArrayHandleCounting ( Thisclass &&  src)
inlinenoexcept

◆ ArrayHandleCounting() [4/8]

template<typename CountingValueType >
VTKM_CONT vtkm::cont::ArrayHandleCounting< CountingValueType >::ArrayHandleCounting ( const vtkm::cont::ArrayHandle< typename Superclass::ValueType, typename Superclass::StorageTag > &  src)
inline

◆ ArrayHandleCounting() [5/8]

template<typename CountingValueType >
VTKM_CONT vtkm::cont::ArrayHandleCounting< CountingValueType >::ArrayHandleCounting ( vtkm::cont::ArrayHandle< typename Superclass::ValueType, typename Superclass::StorageTag > &&  src)
inlinenoexcept

◆ ArrayHandleCounting() [6/8]

template<typename CountingValueType >
VTKM_CONT vtkm::cont::ArrayHandleCounting< CountingValueType >::ArrayHandleCounting ( const std::vector< vtkm::cont::internal::Buffer > &  buffers)
inlineexplicit

◆ ArrayHandleCounting() [7/8]

template<typename CountingValueType >
VTKM_CONT vtkm::cont::ArrayHandleCounting< CountingValueType >::ArrayHandleCounting ( std::vector< vtkm::cont::internal::Buffer > &&  buffers)
inlineexplicitnoexcept

◆ ArrayHandleCounting() [8/8]

template<typename CountingValueType >
vtkm::cont::ArrayHandleCounting< CountingValueType >::ArrayHandleCounting ( CountingValueType  start,
CountingValueType  step,
vtkm::Id  length 
)
inline

Member Function Documentation

◆ GetStart()

template<typename CountingValueType >
CountingValueType vtkm::cont::ArrayHandleCounting< CountingValueType >::GetStart ( ) const
inline

◆ GetStep()

template<typename CountingValueType >
CountingValueType vtkm::cont::ArrayHandleCounting< CountingValueType >::GetStep ( ) const
inline

◆ operator=() [1/2]

template<typename CountingValueType >
VTKM_CONT Thisclass& vtkm::cont::ArrayHandleCounting< CountingValueType >::operator= ( const Thisclass src)
inline

◆ operator=() [2/2]

template<typename CountingValueType >
VTKM_CONT Thisclass& vtkm::cont::ArrayHandleCounting< CountingValueType >::operator= ( Thisclass &&  src)
inlinenoexcept

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