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: CubePrimitive<Scalar: AtomicNumeric>> Atomic<Inner>

pub fn load(&self) -> Inner

Load the value of the atomic.

pub fn store(&self, value: Inner)

Store the value of the atomic.

pub fn exchange(&self, value: Inner) -> Inner

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

pub fn fetch_add(&self, value: Inner) -> Inner

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

pub fn fetch_sub(&self, value: Inner) -> Inner

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

pub fn fetch_max(&self, value: Inner) -> Inner

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

pub fn fetch_min(&self, value: Inner) -> Inner

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

pub fn load_at(&self, sync: SyncScope) -> Inner

load, synchronizing at sync.

The plain operations synchronize at SyncScope::Device, and at SyncScope::System on a Peer buffer, whatever scope they name. The system scope also synchronizes with the host and with kernels on other devices that bind this memory, which is what kernels on different devices signal each other through: publish with sync_system(), then store a flag; spin on the flag, then sync_system() before reading what it guards.

pub fn store_at(&self, value: Inner, sync: SyncScope)

store, synchronizing at sync (see load_at).

pub fn exchange_at(&self, value: Inner, sync: SyncScope) -> Inner

exchange, synchronizing at sync (see load_at).

pub fn fetch_add_at(&self, value: Inner, sync: SyncScope) -> Inner

fetch_add, synchronizing at sync (see load_at).

pub fn fetch_sub_at(&self, value: Inner, sync: SyncScope) -> Inner

fetch_sub, synchronizing at sync (see load_at).

pub fn fetch_max_at(&self, value: Inner, sync: SyncScope) -> Inner

fetch_max, synchronizing at sync (see load_at).

pub fn fetch_min_at(&self, value: Inner, sync: SyncScope) -> Inner

fetch_min, synchronizing at sync (see load_at).

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

Load the value of the atomic.

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

Store the value of the atomic.

pub fn __expand_exchange( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

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

pub fn __expand_fetch_add( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

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

pub fn __expand_fetch_sub( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

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

pub fn __expand_fetch_max( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

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

pub fn __expand_fetch_min( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

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

pub fn __expand_load_at( scope: &Scope, this: &<Self as CubeType>::ExpandType, sync: SyncScope, ) -> <Inner as CubeType>::ExpandType

load, synchronizing at sync.

The plain operations synchronize at SyncScope::Device, and at SyncScope::System on a Peer buffer, whatever scope they name. The system scope also synchronizes with the host and with kernels on other devices that bind this memory, which is what kernels on different devices signal each other through: publish with sync_system(), then store a flag; spin on the flag, then sync_system() before reading what it guards.

pub fn __expand_store_at( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, sync: SyncScope, )

store, synchronizing at sync (see load_at).

pub fn __expand_exchange_at( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, sync: SyncScope, ) -> <Inner as CubeType>::ExpandType

exchange, synchronizing at sync (see load_at).

pub fn __expand_fetch_add_at( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, sync: SyncScope, ) -> <Inner as CubeType>::ExpandType

fetch_add, synchronizing at sync (see load_at).

pub fn __expand_fetch_sub_at( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, sync: SyncScope, ) -> <Inner as CubeType>::ExpandType

fetch_sub, synchronizing at sync (see load_at).

pub fn __expand_fetch_max_at( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, sync: SyncScope, ) -> <Inner as CubeType>::ExpandType

fetch_max, synchronizing at sync (see load_at).

pub fn __expand_fetch_min_at( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, sync: SyncScope, ) -> <Inner as CubeType>::ExpandType

fetch_min, synchronizing at sync (see load_at).

impl<Inner: CubePrimitive<Scalar: Int>> Atomic<Inner>

pub fn compare_exchange_weak(&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 fetch_and(&self, value: Inner) -> Inner

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

pub fn fetch_or(&self, value: Inner) -> Inner

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

pub fn fetch_xor(&self, value: Inner) -> Inner

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

pub fn compare_exchange_weak_at( &self, cmp: Inner, value: Inner, sync: SyncScope, ) -> Inner

compare_exchange_weak, synchronizing at sync (see load_at).

pub fn fetch_and_at(&self, value: Inner, sync: SyncScope) -> Inner

fetch_and, synchronizing at sync (see load_at).

pub fn fetch_or_at(&self, value: Inner, sync: SyncScope) -> Inner

fetch_or, synchronizing at sync (see load_at).

pub fn fetch_xor_at(&self, value: Inner, sync: SyncScope) -> Inner

fetch_xor, synchronizing at sync (see load_at).

pub fn __expand_compare_exchange_weak( scope: &Scope, this: &<Self as CubeType>::ExpandType, cmp: <Inner as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

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 __expand_fetch_and( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

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

pub fn __expand_fetch_or( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

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

pub fn __expand_fetch_xor( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, ) -> <Inner as CubeType>::ExpandType

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

pub fn __expand_compare_exchange_weak_at( scope: &Scope, this: &<Self as CubeType>::ExpandType, cmp: <Inner as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, sync: SyncScope, ) -> <Inner as CubeType>::ExpandType

compare_exchange_weak, synchronizing at sync (see load_at).

pub fn __expand_fetch_and_at( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, sync: SyncScope, ) -> <Inner as CubeType>::ExpandType

fetch_and, synchronizing at sync (see load_at).

pub fn __expand_fetch_or_at( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, sync: SyncScope, ) -> <Inner as CubeType>::ExpandType

fetch_or, synchronizing at sync (see load_at).

pub fn __expand_fetch_xor_at( scope: &Scope, this: &<Self as CubeType>::ExpandType, value: <Inner as CubeType>::ExpandType, sync: SyncScope, ) -> <Inner as CubeType>::ExpandType

fetch_xor, synchronizing at sync (see load_at).

Trait Implementations

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

fn __expand_as_type(scope: &Scope) -> TypeHandle

fn as_type() -> TypeHandle

Return the element type to use on GPU.

fn size() -> usize

Only native element types have a size.

fn size_bits() -> usize

Only native element types have a size.

fn __expand_size(scope: &Scope) -> usize

fn __expand_size_bits(scope: &Scope) -> usize

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

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

fn set_debug_name(&self, scope: &Scope, name: &'static str)

Set the debug name of this type’s expansion. Should do nothing for types that don’t appear at runtime

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

type Scalar = <Inner as CubePrimitive>::Scalar

type Size = Const<1>

type WithScalar<S: Scalar> = Atomic<S>

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

fn from_const_value(_value: ConstantValue) -> Self

fn into_lit_unchecked(self) -> Self

fn packing_factor() -> usize

fn vector_size() -> usize

fn __expand_packing_factor(scope: &Scope) -> usize

fn __expand_vector_size(scope: &Scope) -> usize

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

type ExpandType = NativeExpand<Atomic<Inner>>

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

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> NativeAssign for Atomic<Inner>

fn elem_init_mut(scope: &Scope, elem: ExpandValue) -> ExpandValue

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

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

Equality operator ==.

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

Inequality operator !=.

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