Enum Variable 

pub enum Variable<D: Dialect> {
    AbsolutePos(Elem<D>),
    AbsolutePosBaseName,
    AbsolutePosX,
    AbsolutePosY,
    AbsolutePosZ,
    UnitPos,
    UnitPosBaseName,
    UnitPosX,
    UnitPosY,
    UnitPosZ,
    CubePos(Elem<D>),
    CubePosBaseName,
    CubePosX,
    CubePosY,
    CubePosZ,
    CubeDim,
    CubeDimBaseName,
    CubeDimX,
    CubeDimY,
    CubeDimZ,
    CubeCount(Elem<D>),
    CubeCountBaseName,
    CubeCountX,
    CubeCountY,
    CubeCountZ,
    PlaneDim,
    PlaneDimChecked,
    PlanePos,
    UnitPosPlane,
    ClusterRank,
    ClusterIndexX,
    ClusterIndexY,
    ClusterIndexZ,
    GlobalInputArray(Id, Item<D>),
    GlobalOutputArray(Id, Item<D>),
    GlobalScalar {
        id: Id,
        elem: Elem<D>,
        in_struct: bool,
    },
    ConstantArray(Id, Item<D>, usize),
    Constant(ConstantValue, Item<D>),
    TensorMap(Id),
    LocalMut {
        id: Id,
        item: Item<D>,
    },
    LocalConst {
        id: Id,
        item: Item<D>,
    },
    Named {
        name: &'static str,
        item: Item<D>,
    },
    Slice {
        id: Id,
        item: Item<D>,
    },
    SharedArray(Id, Item<D>, usize),
    Shared(Id, Item<D>),
    LocalArray(Id, Item<D>, usize),
    WmmaFragment {
        id: Id,
        frag: Fragment<D>,
    },
    Pipeline {
        id: Id,
    },
    Barrier {
        id: Id,
        level: BarrierLevel,
    },
    BarrierToken {
        id: Id,
        level: BarrierLevel,
    },
    Tmp {
        id: Id,
        item: Item<D>,
        is_declared: bool,
        is_ptr: bool,
        is_const: bool,
    },
}

Variants

AbsolutePos(Elem<D>)

AbsolutePosBaseName

AbsolutePosX

AbsolutePosY

AbsolutePosZ

UnitPos

UnitPosBaseName

UnitPosX

UnitPosY

UnitPosZ

CubePos(Elem<D>)

CubePosBaseName

CubePosX

CubePosY

CubePosZ

CubeDim

CubeDimBaseName

CubeDimX

CubeDimY

CubeDimZ

CubeCount(Elem<D>)

CubeCountBaseName

CubeCountX

CubeCountY

CubeCountZ

PlaneDim

PlaneDimChecked

PlanePos

UnitPosPlane

ClusterRank

ClusterIndexX

ClusterIndexY

ClusterIndexZ

GlobalInputArray(Id, Item<D>)

GlobalOutputArray(Id, Item<D>)

GlobalScalar

Fields

id: Id

elem: Elem<D>

in_struct: bool

ConstantArray(Id, Item<D>, usize)

Constant(ConstantValue, Item<D>)

TensorMap(Id)

LocalMut

Fields

id: Id

item: Item<D>

LocalConst

Fields

id: Id

item: Item<D>

Named

Fields

name: &'static str

item: Item<D>

Slice

Fields

id: Id

item: Item<D>

SharedArray(Id, Item<D>, usize)

Shared(Id, Item<D>)

LocalArray(Id, Item<D>, usize)

WmmaFragment

Fields

id: Id

frag: Fragment<D>

Pipeline

Fields

id: Id

Barrier

Fields

id: Id

level: BarrierLevel

BarrierToken

Fields

id: Id

level: BarrierLevel

Tmp

Fields

id: Id

item: Item<D>

is_declared: bool

is_ptr: bool

is_const: bool

Implementations

impl<D: Dialect> Variable<D>

pub fn is_optimized(&self) -> bool

pub fn tmp(item: Item<D>) -> Self

Create a temporary variable.

Also see Self::tmp_declared for a version that needs custom declaration.

pub fn to_const(&mut self)

pub fn reinterpret_ptr(&self, f: &mut Formatter<'_>, item: Item<D>) -> Self

Create a temporary variable with a reinterpret_cast.

pub fn tmp_ptr(item: Item<D>) -> Self

Create a temporary pointer variable.

Also see Self::tmp_declared for a version that needs custom declaration.

pub fn tmp_declared(item: Item<D>) -> Self

Create a temporary variable with a custom declaration.

Notes

Calling var.fmt_left() will assume the variable already exist.

pub fn optimized_args<const N: usize>(args: [Self; N]) -> OptimizedArgs<N, D>

pub fn optimized(&self) -> Self

pub fn is_always_scalar(&self) -> bool

pub fn index(&self, index: usize) -> IndexedVariable<D>

pub fn const_qualifier(&self) -> &str

pub fn id(&self) -> Option<Id>

pub fn fmt_ptr(&self) -> String

Format variable for a pointer argument. Slices and buffers are already pointers, so we just leave them as is to avoid accidental double pointers

pub fn fmt_cast_to(&self, item: Item<D>) -> String

Format an item with a specific type, casting if necessary

impl<D: Dialect> Variable<D>

pub fn attribute(&self) -> BuiltInAttribute

Trait Implementations

impl<D: Clone + Dialect> Clone for Variable<D>

fn clone(&self) -> Variable<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Dialect> Component<D> for Variable<D>

fn index(&self, index: usize) -> IndexedVariable<D>

fn item(&self) -> Item<D>

fn is_const(&self) -> bool

fn elem(&self) -> Elem<D>

impl<D: Debug + Dialect> Debug for Variable<D>

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

Formats the value using the given formatter.

impl<D: Dialect> Display for Variable<D>

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

Formats the value using the given formatter.

impl<D: Dialect> FmtLeft for Variable<D>

fn fmt_left(&self) -> String

impl<D: Dialect> From<&Variable<D>> for AddressSpace

fn from(value: &Variable<D>) -> Self

Converts to this type from the input type.

impl<D: PartialEq + Dialect> PartialEq for Variable<D>

fn eq(&self, other: &Variable<D>) -> 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<D: Copy + Dialect> Copy for Variable<D>

impl<D: Dialect> StructuralPartialEq for Variable<D>