VTK-m  2.1
Public Types | Public Member Functions | List of all members
vtkm::cont::ArrayHandleRandomUniformBits Class Reference

An ArrayHandle that provides a source of random bits. More...

#include <ArrayHandleRandomUniformBits.h>

Inheritance diagram for vtkm::cont::ArrayHandleRandomUniformBits:
vtkm::cont::ArrayHandleImplicit< detail::PhiloxFunctor > vtkm::cont::ArrayHandle< T, StorageTag_ >

Public Types

using SeedType = vtkm::Vec< vtkm::UInt32, 1 >
 
using Thisclass = vtkm::cont::detail::GetTypeInParentheses< void(ArrayHandleRandomUniformBits) >::type
 
using Superclass = vtkm::cont::detail::GetTypeInParentheses< void(vtkm::cont::ArrayHandleImplicit< detail::PhiloxFunctor >) >::type
 
using ValueType = Superclass::ValueType
 
using StorageTag = Superclass::StorageTag
 
using StorageType = Superclass::StorageType
 
using ReadPortalType = Superclass::ReadPortalType
 
using WritePortalType = Superclass::WritePortalType
 
- Public Types inherited from vtkm::cont::ArrayHandle< T, StorageTag_ >
using ValueType = T
 
using StorageTag = StorageTag_
 
using StorageType = vtkm::cont::internal::Storage< ValueType, StorageTag >
 
using ReadPortalType = typename StorageType::ReadPortalType
 
using WritePortalType = typename StorageType::WritePortalType
 

Public Member Functions

 ArrayHandleRandomUniformBits ()
 
VTKM_CONT ArrayHandleRandomUniformBits (const Thisclass &src)
 
VTKM_CONT ArrayHandleRandomUniformBits (Thisclass &&src) noexcept
 
VTKM_CONT ArrayHandleRandomUniformBits (const vtkm::cont::ArrayHandle< Superclass::ValueType, Superclass::StorageTag > &src)
 
VTKM_CONT ArrayHandleRandomUniformBits (vtkm::cont::ArrayHandle< Superclass::ValueType, Superclass::StorageTag > &&src) noexcept
 
VTKM_CONT ArrayHandleRandomUniformBits (const std::vector< vtkm::cont::internal::Buffer > &buffers)
 
VTKM_CONT ArrayHandleRandomUniformBits (std::vector< vtkm::cont::internal::Buffer > &&buffers) noexcept
 
VTKM_CONT Thisclassoperator= (const Thisclass &src)
 
VTKM_CONT Thisclassoperator= (Thisclass &&src) noexcept
 
 ArrayHandleRandomUniformBits (vtkm::Id length, SeedType seed={ std::random_device{}() })
 The type of seed is specifically designed to be an vtkm::Vec<> to provide type safety for the parameters so user will not transpose two integer parameters. More...
 
- Public Member Functions inherited from vtkm::cont::ArrayHandle< T, 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 ArrayHandles are considered equal if they point to the same location in memory. More...
 
bool operator!= (const ArrayHandle< ValueType, StorageTag > &rhs) const
 
template<typename VT , typename ST >
bool operator== (const ArrayHandle< VT, ST > &) const
 
template<typename VT , typename ST >
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< T, 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

An ArrayHandle that provides a source of random bits.

ArrayHandleRandomUniformBits is a specialization of ArrayHandleImplicit. It takes a user supplied seed and hash it with the a given index value. The hashed value is the value of the array at that position.

Currently, Philox2x32x10 as described in the "Parallel Random Numbers: As Easy as 1, 2, 3," Proceedings of the International Conference for High Performance Computing, Networking, Storage and Analysis (SC11) is used as the hash function.

Note: In contrast to traditional random number generator, ArrayHandleRandomUniformBits does not have "state", i.e. multiple calls the Get() method with the same index will always return the same hash value. To ge a new set of random bits, create a new ArrayHandleRandomUniformBits with a different seed.

Member Typedef Documentation

◆ ReadPortalType

◆ SeedType

◆ StorageTag

◆ StorageType

◆ Superclass

using vtkm::cont::ArrayHandleRandomUniformBits::Superclass = vtkm::cont::detail::GetTypeInParentheses<void (vtkm::cont::ArrayHandleImplicit<detail::PhiloxFunctor>) >::type

◆ Thisclass

using vtkm::cont::ArrayHandleRandomUniformBits::Thisclass = vtkm::cont::detail::GetTypeInParentheses<void ( ArrayHandleRandomUniformBits ) >::type

◆ ValueType

◆ WritePortalType

using vtkm::cont::ArrayHandleRandomUniformBits::WritePortalType = Superclass::WritePortalType

Constructor & Destructor Documentation

◆ ArrayHandleRandomUniformBits() [1/8]

vtkm::cont::ArrayHandleRandomUniformBits::ArrayHandleRandomUniformBits ( )
inline

◆ ArrayHandleRandomUniformBits() [2/8]

VTKM_CONT vtkm::cont::ArrayHandleRandomUniformBits::ArrayHandleRandomUniformBits ( const Thisclass src)
inline

◆ ArrayHandleRandomUniformBits() [3/8]

VTKM_CONT vtkm::cont::ArrayHandleRandomUniformBits::ArrayHandleRandomUniformBits ( Thisclass &&  src)
inlinenoexcept

◆ ArrayHandleRandomUniformBits() [4/8]

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

◆ ArrayHandleRandomUniformBits() [5/8]

VTKM_CONT vtkm::cont::ArrayHandleRandomUniformBits::ArrayHandleRandomUniformBits ( vtkm::cont::ArrayHandle< Superclass::ValueType, Superclass::StorageTag > &&  src)
inlinenoexcept

◆ ArrayHandleRandomUniformBits() [6/8]

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

◆ ArrayHandleRandomUniformBits() [7/8]

VTKM_CONT vtkm::cont::ArrayHandleRandomUniformBits::ArrayHandleRandomUniformBits ( std::vector< vtkm::cont::internal::Buffer > &&  buffers)
inlineexplicitnoexcept

◆ ArrayHandleRandomUniformBits() [8/8]

vtkm::cont::ArrayHandleRandomUniformBits::ArrayHandleRandomUniformBits ( vtkm::Id  length,
SeedType  seed = { std::random_device{}() } 
)
inlineexplicit

The type of seed is specifically designed to be an vtkm::Vec<> to provide type safety for the parameters so user will not transpose two integer parameters.

Member Function Documentation

◆ operator=() [1/2]

VTKM_CONT Thisclass& vtkm::cont::ArrayHandleRandomUniformBits::operator= ( const Thisclass src)
inline

◆ operator=() [2/2]

VTKM_CONT Thisclass& vtkm::cont::ArrayHandleRandomUniformBits::operator= ( Thisclass &&  src)
inlinenoexcept

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