A scatter that maps input to output based on a permutation array. More...
#include <ScatterPermutation.h>
Inheritance diagram for viskores::worklet::ScatterPermutation< PermutationStorage >:
Public Types | |
| using | OutputToInputMapType = PermutationArrayHandle |
| using | VisitArrayType = viskores::cont::ArrayHandleConstant< viskores::IdComponent > |
Public Member Functions | |
| ScatterPermutation (const PermutationArrayHandle &permutation) | |
| template<typename RangeType > | |
| viskores::Id | GetOutputRange (RangeType) const |
| template<typename RangeType > | |
| OutputToInputMapType | GetOutputToInputMap (RangeType) const |
| OutputToInputMapType | GetOutputToInputMap () const |
| VisitArrayType | GetVisitArray (viskores::Id inputRange) const |
| VisitArrayType | GetVisitArray (viskores::Id3 inputRange) const |
Private Types | |
| using | PermutationArrayHandle = viskores::cont::ArrayHandle< viskores::Id, PermutationStorage > |
Private Attributes | |
| PermutationArrayHandle | Permutation |
Detailed Description
template<typename PermutationStorage = VISKORES_DEFAULT_STORAGE_TAG>
class viskores::worklet::ScatterPermutation< PermutationStorage >
A scatter that maps input to output based on a permutation array.
The Scatter classes are responsible for defining how much output is generated based on some sized input. ScatterPermutation is similar to ScatterCounting but can have lesser memory usage for some cases. The constructor takes an array of ids, where each entry maps the corresponding output to an input. The ids can be in any order and there can be duplicates. Note that even with duplicates the VistIndex is always 0.
Member Typedef Documentation
◆ OutputToInputMapType
template<typename PermutationStorage = VISKORES_DEFAULT_STORAGE_TAG>
| using viskores::worklet::ScatterPermutation< PermutationStorage >::OutputToInputMapType = PermutationArrayHandle |
◆ PermutationArrayHandle
template<typename PermutationStorage = VISKORES_DEFAULT_STORAGE_TAG>
|
private |
◆ VisitArrayType
template<typename PermutationStorage = VISKORES_DEFAULT_STORAGE_TAG>
| using viskores::worklet::ScatterPermutation< PermutationStorage >::VisitArrayType = viskores::cont::ArrayHandleConstant<viskores::IdComponent> |
Constructor & Destructor Documentation
◆ ScatterPermutation()
template<typename PermutationStorage = VISKORES_DEFAULT_STORAGE_TAG>
|
inline |
Member Function Documentation
◆ GetOutputRange()
template<typename PermutationStorage = VISKORES_DEFAULT_STORAGE_TAG>
template<typename RangeType >
|
inline |
◆ GetOutputToInputMap() [1/2]
template<typename PermutationStorage = VISKORES_DEFAULT_STORAGE_TAG>
|
inline |
◆ GetOutputToInputMap() [2/2]
template<typename PermutationStorage = VISKORES_DEFAULT_STORAGE_TAG>
template<typename RangeType >
|
inline |
◆ GetVisitArray() [1/2]
template<typename PermutationStorage = VISKORES_DEFAULT_STORAGE_TAG>
|
inline |
◆ GetVisitArray() [2/2]
template<typename PermutationStorage = VISKORES_DEFAULT_STORAGE_TAG>
|
inline |
Member Data Documentation
◆ Permutation
template<typename PermutationStorage = VISKORES_DEFAULT_STORAGE_TAG>
|
private |
The documentation for this class was generated from the following file:
