Struct Atomic

pub struct Atomic<Inner: CubePrimitive> {
    pub val: Inner,
}

An atomic numerical type wrapping a normal numeric primitive. Enables the use of atomic operations, while disabling normal operations. In WGSL, this is a separate type - on CUDA/SPIR-V it can theoretically be bitcast to a normal number, but this isn’t recommended.

Fields

val: Inner

Implementations

impl<Inner: Numeric> Atomic<Inner>

pub fn load(pointer: &Self) -> Inner

Load the value of the atomic.

pub fn store(pointer: &Self, value: Inner)

Store the value of the atomic.

pub fn swap(pointer: &Self, value: Inner) -> Inner

Atomically stores the value into the atomic and returns the old value.

pub fn add(pointer: &Self, value: Inner) -> Inner

Atomically add a number to the atomic variable. Returns the old value.

pub fn max(pointer: &Self, value: Inner) -> Inner

Atomically sets the value of the atomic variable to max(current_value, value). Returns the old value.

pub fn min(pointer: &Self, value: Inner) -> Inner

Atomically sets the value of the atomic variable to min(current_value, value). Returns the old value.

pub fn sub(pointer: &Self, value: Inner) -> Inner

Atomically subtracts a number from the atomic variable. Returns the old value.

pub fn __expand_load( scope: &mut Scope, pointer: <Self as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

pub fn __expand_store( scope: &mut Scope, pointer: <Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, )

pub fn __expand_swap( scope: &mut Scope, pointer: <Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

pub fn __expand_add( scope: &mut Scope, pointer: <Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

pub fn __expand_sub( scope: &mut Scope, pointer: <Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

pub fn __expand_max( scope: &mut Scope, pointer: <Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

pub fn __expand_min( scope: &mut Scope, pointer: <Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

impl<Inner: Int> Atomic<Inner>

pub fn compare_and_swap(pointer: &Self, cmp: Inner, value: Inner) -> Inner

Compare the value at pointer to cmp and set it to value only if they are the same. Returns the old value of the pointer before the store.

Tip

Compare the returned value to cmp to determine whether the store was successful.

pub fn and(pointer: &Self, value: Inner) -> Inner

Executes an atomic bitwise and operation on the atomic variable. Returns the old value.

pub fn or(pointer: &Self, value: Inner) -> Inner

Executes an atomic bitwise or operation on the atomic variable. Returns the old value.

pub fn xor(pointer: &Self, value: Inner) -> Inner

Executes an atomic bitwise xor operation on the atomic variable. Returns the old value.

pub fn __expand_compare_and_swap( scope: &mut Scope, pointer: <Self as CubeType>::ExpandType, cmp: <Inner as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

pub fn __expand_and( scope: &mut Scope, pointer: <Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

pub fn __expand_or( scope: &mut Scope, pointer: <Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

pub fn __expand_xor( scope: &mut Scope, pointer: <Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

Trait Implementations

impl<Inner: Clone + CubePrimitive> Clone for Atomic<Inner>

fn clone(&self) -> Atomic<Inner>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Inner: CubePrimitive> CubePrimitive for Atomic<Inner>

fn as_elem_native() -> Option<Elem>

Native or static element type.

fn as_elem(scope: &Scope) -> Elem

Return the element type to use on GPU.

fn as_elem_native_unchecked() -> Elem

Native or static element type.

fn size() -> Option<usize>

Only native element types have a size.

fn from_expand_elem(elem: ExpandElement) -> Self::ExpandType

fn is_supported<S: ComputeServer<Feature = Feature>, C: ComputeChannel<S>>( client: &ComputeClient<S, C>, ) -> bool

fn elem_size() -> u32

fn __expand_elem_size(context: &Scope) -> u32

impl<Inner: CubePrimitive> CubeType for Atomic<Inner>

type ExpandType = ExpandElementTyped<Atomic<Inner>>

fn init(scope: &mut Scope, expand: Self::ExpandType) -> Self::ExpandType

Wrapper around the init method, necessary to type inference.

impl<Inner: CubePrimitive> ExpandElementBaseInit for Atomic<Inner>

fn init_elem(scope: &mut Scope, elem: ExpandElement) -> ExpandElement

impl<Inner: Hash + CubePrimitive> Hash for Atomic<Inner>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Inner: CubePrimitive> LaunchArgExpand for Atomic<Inner>

type CompilationArg = ()

Compilation argument.

fn expand( _: &Self::CompilationArg, builder: &mut KernelBuilder, ) -> ExpandElementTyped<Self>

Register an input variable during compilation that fill the KernelBuilder.

fn expand_output( arg: &Self::CompilationArg, builder: &mut KernelBuilder, ) -> <Self as CubeType>::ExpandType

Register an output variable during compilation that fill the KernelBuilder.

impl<Inner: PartialEq + CubePrimitive> PartialEq for Atomic<Inner>

fn eq(&self, other: &Atomic<Inner>) -> 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<Inner: Copy + CubePrimitive> Copy for Atomic<Inner>

impl<Inner: Eq + CubePrimitive> Eq for Atomic<Inner>

impl<Inner: CubePrimitive> StructuralPartialEq for Atomic<Inner>