Enum GroupOperation

#[non_exhaustive]
pub enum GroupOperation {
    Reduce = 0,
    InclusiveScan = 1,
    ExclusiveScan = 2,
    ClusteredReduce = 3,
    PartitionedReduceNV = 6,
    PartitionedInclusiveScanNV = 7,
    PartitionedExclusiveScanNV = 8,
}

Defines the class of group operation.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Reduce = 0

A reduction operation for all values of a specific value X specified by invocations within a workgroup.

InclusiveScan = 1

A binary operation with an identity I and n (where n is the size of the workgroup) elements[a0, a1, … an-1] resulting in [a0, (a0 op a1), …(a0 op a1 op … op an-1)]

ExclusiveScan = 2

A binary operation with an identity I and n (where n is the size of the workgroup) elements[a0, a1, … an-1] resulting in [I, a0, (a0 op a1), … (a0 op a1 op … op an-2)].

ClusteredReduce = 3

The GroupOperation ClusteredReduce.

All instructions with a GroupOperation require an additional ClusterSize parameter when GroupOperation is ClusteredReduce. To map this requirement into rust, all function have a base version accepting GroupOperation as a const generic, and a _clustered variant that is fixed to ClusteredReduce and takes the additional ClusterSize parameter as a const generic. To not accidentally use a ClusteredReduce in the base variant of the function, it was removed from the GroupOperation enum and instead resides individually.

PartitionedReduceNV = 6

Reserved.

Requires Capability GroupNonUniformPartitionedNV.

PartitionedInclusiveScanNV = 7

Reserved.

Requires Capability GroupNonUniformPartitionedNV.

PartitionedExclusiveScanNV = 8

Reserved.

Requires Capability GroupNonUniformPartitionedNV.

Trait Implementations

impl Debug for GroupOperation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GroupOperation

fn eq(&self, other: &GroupOperation) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for GroupOperation

impl StructuralPartialEq for GroupOperation