VTK-m  2.0
Public Member Functions | Private Types | Private Attributes | List of all members
vtkm::exec::arg::ThreadIndicesReduceByKey Class Reference

Container for thread indices in a reduce by key invocation. More...

#include <ThreadIndicesReduceByKey.h>

Inheritance diagram for vtkm::exec::arg::ThreadIndicesReduceByKey:
vtkm::exec::arg::ThreadIndicesBasic

Public Member Functions

template<typename P1 , typename P2 >
VTKM_EXEC ThreadIndicesReduceByKey (vtkm::Id threadIndex, vtkm::Id inIndex, vtkm::IdComponent visitIndex, vtkm::Id outIndex, const vtkm::exec::internal::ReduceByKeyLookupBase< P1, P2 > &keyLookup)
 
VTKM_EXEC vtkm::Id GetValueOffset () const
 
VTKM_EXEC vtkm::IdComponent GetNumberOfValues () const
 
- Public Member Functions inherited from vtkm::exec::arg::ThreadIndicesBasic
VTKM_EXEC ThreadIndicesBasic (vtkm::Id threadIndex, vtkm::Id inIndex, vtkm::IdComponent visitIndex, vtkm::Id outIndex)
 
VTKM_EXEC vtkm::Id GetThreadIndex () const
 The index of the thread or work invocation. More...
 
VTKM_EXEC vtkm::Id GetInputIndex () const
 The index into the input domain. More...
 
VTKM_EXEC vtkm::Id3 GetInputIndex3D () const
 The 3D index into the input domain. More...
 
VTKM_EXEC vtkm::Id GetOutputIndex () const
 The index into the output domain. More...
 
VTKM_EXEC vtkm::IdComponent GetVisitIndex () const
 The visit index. More...
 

Private Types

using Superclass = vtkm::exec::arg::ThreadIndicesBasic
 

Private Attributes

vtkm::Id ValueOffset
 
vtkm::IdComponent NumberOfValues
 

Detailed Description

Container for thread indices in a reduce by key invocation.

This specialization of ThreadIndices adds extra indices that deal with a reduce by key. In particular, it save the indices used to map from a unique key index to the group of input values that has that key associated with it.

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ ThreadIndicesReduceByKey()

template<typename P1 , typename P2 >
VTKM_EXEC vtkm::exec::arg::ThreadIndicesReduceByKey::ThreadIndicesReduceByKey ( vtkm::Id  threadIndex,
vtkm::Id  inIndex,
vtkm::IdComponent  visitIndex,
vtkm::Id  outIndex,
const vtkm::exec::internal::ReduceByKeyLookupBase< P1, P2 > &  keyLookup 
)
inline

Member Function Documentation

◆ GetNumberOfValues()

VTKM_EXEC vtkm::IdComponent vtkm::exec::arg::ThreadIndicesReduceByKey::GetNumberOfValues ( ) const
inline

◆ GetValueOffset()

VTKM_EXEC vtkm::Id vtkm::exec::arg::ThreadIndicesReduceByKey::GetValueOffset ( ) const
inline

Member Data Documentation

◆ NumberOfValues

vtkm::IdComponent vtkm::exec::arg::ThreadIndicesReduceByKey::NumberOfValues
private

◆ ValueOffset

vtkm::Id vtkm::exec::arg::ThreadIndicesReduceByKey::ValueOffset
private

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