Struct ShuffleOperation 

pub struct ShuffleOperation<'c> { /* private fields */ }

A shuffle operation. Shuffles values within a subgroup..

The “shuffle” op moves values across lanes in a subgroup (a.k.a., local invocation) within the same subgroup. The width argument specifies the number of lanes that participate in the shuffle, and must be uniform across all lanes. Further, the first width lanes of the subgroup must be active.

The intepretation of the offset arguments depends on the selected mode.

Returns the shuffleResult and true if the current lane id is smaller than width, and an unspecified value and false otherwise.

xor example:

%1, %2 = gpu.shuffle xor %0, %offset, %width : f32

For lane k, returns the value %0 from lane k ^ offset. Every lane trades value with exactly one other lane.

down example:

%cst1 = arith.constant 1 : i32
%3, %4 = gpu.shuffle down %0, %cst1, %width : f32

For lane k, returns the value from lane (k + cst1). If (k + cst1) is bigger than or equal to width, the value is poison and valid is false.

up example:

%cst1 = arith.constant 1 : i32
%5, %6 = gpu.shuffle up %0, %cst1, %width : f32

For lane k, returns the value from lane (k - cst1). If (k - cst1) is smaller than 0, the value is poison and valid is false.

idx example:

%cst0 = arith.constant 0 : i32
%7, %8 = gpu.shuffle idx %0, %cst0, %width : f32

Broadcasts the value from lane 0 to all lanes.

Implementations

impl<'c> ShuffleOperation<'c>

pub fn name() -> &'static str

Returns a name.

pub fn as_operation(&self) -> &Operation<'c>

Returns a generic operation.

pub fn builder( context: &'c Context, location: Location<'c>, ) -> ShuffleOperationBuilder<'c, Unset, Unset, Unset, Unset, Unset, Unset>

Creates a builder.

pub fn shuffle_result(&self) -> Result<OperationResult<'c, '_>, Error>

pub fn valid(&self) -> Result<OperationResult<'c, '_>, Error>

pub fn value(&self) -> Result<Value<'c, '_>, Error>

pub fn offset(&self) -> Result<Value<'c, '_>, Error>

pub fn width(&self) -> Result<Value<'c, '_>, Error>

pub fn mode(&self) -> Result<Attribute<'c>, Error>

pub fn set_mode(&mut self, value: Attribute<'c>)

Trait Implementations

impl<'c> Clone for ShuffleOperation<'c>

fn clone(&self) -> ShuffleOperation<'c>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'c> Debug for ShuffleOperation<'c>

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

Formats the value using the given formatter.

impl<'b> From<ShuffleOperation<'b>> for GpuDialectOperation<'b>

fn from(op: ShuffleOperation<'b>) -> Self

Converts to this type from the input type.

impl<'c> From<ShuffleOperation<'c>> for Operation<'c>

fn from(operation: ShuffleOperation<'c>) -> Self

Converts to this type from the input type.

impl<'c> PartialEq for ShuffleOperation<'c>

fn eq(&self, other: &ShuffleOperation<'c>) -> bool

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

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<'c> TryFrom<Operation<'c>> for ShuffleOperation<'c>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(operation: Operation<'c>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'c> Eq for ShuffleOperation<'c>

impl<'c> StructuralPartialEq for ShuffleOperation<'c>