Struct Sequence 

pub struct Sequence<T>
where
    T: CubeType,
{ /* private fields */ }

A sequence of cube types that is inlined during compilation.

In other words, it allows you to group a dynamic amount of variables at compile time.

All methods push, index and into_iter are executed during compilation and don’t add any overhead on the generated kernel.

Implementations

impl<T> Sequence<T>

where T: CubeType + Clone,

pub fn rev(&self) -> Sequence<T>

impl<T> Sequence<T>

where T: CubeType,

pub fn new() -> Sequence<T>

Create a new empty sequence.

pub fn push(&mut self, value: T)

Push a new value into the sequence.

pub fn len(&self) -> usize

Obtain the sequence length.

pub fn index(&self, index: usize) -> &T

Get the variable at the given position in the sequence.

pub fn index_mut(&mut self, index: usize) -> &mut T

Get the variable at the given position in the sequence.

pub fn __expand_new(_scope: &mut Scope) -> SequenceExpand<T>

Expand function of new.

pub fn insert(&mut self, index: usize, value: T)

Insert an item at the given index.

pub fn __expand_push( scope: &mut Scope, expand: &mut SequenceExpand<T>, value: <T as CubeType>::ExpandType, )

Expand function of push.

pub fn __expand_index( scope: &mut Scope, expand: SequenceExpand<T>, index: usize, ) -> <T as CubeType>::ExpandType

Expand function of index.

pub fn __expand_index_mut( scope: &mut Scope, expand: SequenceExpand<T>, index: usize, ) -> <T as CubeType>::ExpandType

Expand function of index_mut.

Trait Implementations

impl<T> Clone for Sequence<T>

where T: Clone + CubeType,

fn clone(&self) -> Sequence<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Coordinates for Sequence<T>

where T: Coordinates + Copy,

fn add(this: Sequence<T>, other: Sequence<T>) -> Sequence<T>

Add two coordinates together and return the result.

fn sub(this: Sequence<T>, other: Sequence<T>) -> Sequence<T>

Subtract two coordinates from each other and return the result.

fn min(this: Sequence<T>, other: Sequence<T>) -> Sequence<T>

Apply an elementwise minimum to the coordinates and return the result.

fn max(this: Sequence<T>, other: Sequence<T>) -> Sequence<T>

Apply an elementwise maximum to the coordinates and return the result.

fn is_in_bounds(pos: &Sequence<T>, bounds: &Sequence<T>) -> bool

Check whether pos is fully contained within bounds.

fn from_int(this: &Sequence<T>, value: i64) -> Sequence<T>

Create a new coordinates object where all values are value. this may be used as a reference coordinate for dynamically sized layouts.

fn __expand_add( scope: &mut Scope, this: <Sequence<T> as CubeType>::ExpandType, other: <Sequence<T> as CubeType>::ExpandType, ) -> <Sequence<T> as CubeType>::ExpandType

fn __expand_sub( scope: &mut Scope, this: <Sequence<T> as CubeType>::ExpandType, other: <Sequence<T> as CubeType>::ExpandType, ) -> <Sequence<T> as CubeType>::ExpandType

fn __expand_min( scope: &mut Scope, this: <Sequence<T> as CubeType>::ExpandType, other: <Sequence<T> as CubeType>::ExpandType, ) -> <Sequence<T> as CubeType>::ExpandType

fn __expand_max( scope: &mut Scope, this: <Sequence<T> as CubeType>::ExpandType, other: <Sequence<T> as CubeType>::ExpandType, ) -> <Sequence<T> as CubeType>::ExpandType

fn __expand_is_in_bounds( scope: &mut Scope, pos: <Sequence<T> as CubeType>::ExpandType, bounds: <Sequence<T> as CubeType>::ExpandType, ) -> <bool as CubeType>::ExpandType

fn __expand_from_int( scope: &mut Scope, this: <Sequence<T> as CubeType>::ExpandType, value: i64, ) -> <Sequence<T> as CubeType>::ExpandType

impl<T> CubeDebug for Sequence<T>

where T: CubeType,

fn set_debug_name(&self, scope: &mut 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<T> CubeIndex for Sequence<T>

where T: CubeType,

type Output = T

type Idx = usize

fn cube_idx(&self, _i: Self::Idx) -> &Self::Output

fn expand_index( scope: &mut Scope, array: Self::ExpandType, index: <Self::Idx as CubeType>::ExpandType, ) -> <Self::Output as CubeType>::ExpandType

fn expand_index_unchecked( scope: &mut Scope, array: Self::ExpandType, index: <Self::Idx as CubeType>::ExpandType, ) -> <Self::Output as CubeType>::ExpandType

impl<T> CubeType for Sequence<T>

where T: CubeType,

type ExpandType = SequenceExpand<T>

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

Wrapper around the init method, necessary to type inference.

impl<T> Debug for Sequence<T>

where T: Debug + CubeType,

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

Formats the value using the given formatter.

impl<T> Default for Sequence<T>

where T: CubeType,

fn default() -> Sequence<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Sequence<T>

where T: CubeType + Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Sequence<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Hash for Sequence<T>

where T: Hash + CubeType,

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

where __H: Hasher,

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 IntoDyn for Sequence<i32>

fn into_dyn(self) -> Sequence<i32>

fn __expand_into_dyn( scope: &mut Scope, this: Self::ExpandType, ) -> <Sequence<i32> as CubeType>::ExpandType

impl IntoDyn for Sequence<u32>

fn into_dyn(self) -> Sequence<i32>

fn __expand_into_dyn( scope: &mut Scope, this: Self::ExpandType, ) -> <Sequence<i32> as CubeType>::ExpandType

impl<T> IntoIterator for Sequence<T>

where T: CubeType,

type Item = T

The type of the elements being iterated over.

type IntoIter = <Vec<T> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Sequence<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> IntoMut for Sequence<T>

where T: CubeType,

fn into_mut(self, _scope: &mut Scope) -> Sequence<T>

impl<C> LaunchArg for Sequence<C>

where C: LaunchArg,

type RuntimeArg<'a, R: Runtime> = SequenceArg<'a, R, C>

The runtime argument for the kernel.

type CompilationArg = SequenceCompilationArg<C>

Compilation argument.

fn compilation_arg<R>( runtime_arg: &<Sequence<C> as LaunchArg>::RuntimeArg<'_, R>, ) -> <Sequence<C> as LaunchArg>::CompilationArg

where R: Runtime,

fn expand( arg: &<Sequence<C> as LaunchArg>::CompilationArg, builder: &mut KernelBuilder, ) -> SequenceExpand<C>

Register an input variable during compilation that fill the KernelBuilder.

fn expand_output( arg: &<Sequence<C> as LaunchArg>::CompilationArg, builder: &mut KernelBuilder, ) -> SequenceExpand<C>

Register an output variable during compilation that fill the KernelBuilder.

impl<T> Ord for Sequence<T>

where T: Ord + CubeType,

fn cmp(&self, other: &Sequence<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for Sequence<T>

where T: PartialEq + CubeType,

fn eq(&self, other: &Sequence<T>) -> 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<T> PartialOrd for Sequence<T>

where T: PartialOrd + CubeType,

fn partial_cmp(&self, other: &Sequence<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for Sequence<T>

where T: CubeType + Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, N> ViewOperations<T, Sequence<N>> for TensorMap<T, Tiled>

where T: CubePrimitive, N: CubePrimitive + Coordinates,

fn read(&self, pos: C) -> T

fn read_checked(&self, pos: C) -> T

fn read_masked(&self, pos: C, value: T) -> T

fn read_unchecked(&self, pos: C) -> T

fn to_linear_slice(&self, pos: C, size: C) -> Slice<T>

Create a slice starting from pos, with size. The layout handles translation into concrete indices.

fn tensor_map_load( &self, barrier: &Barrier, shared_memory: &mut Slice<T, ReadWrite>, pos: C, )

.Execute a TMA load into shared memory, if the underlying storage supports it. Panics if it’s unsupported.

fn shape(&self) -> C

fn is_in_bounds(&self, pos: C) -> bool

fn __expand_read( scope: &mut Scope, this: Self::ExpandType, pos: <C as CubeType>::ExpandType, ) -> <T as CubeType>::ExpandType

fn __expand_read_checked( scope: &mut Scope, this: Self::ExpandType, pos: <C as CubeType>::ExpandType, ) -> <T as CubeType>::ExpandType

fn __expand_read_masked( scope: &mut Scope, this: Self::ExpandType, pos: <C as CubeType>::ExpandType, value: <T as CubeType>::ExpandType, ) -> <T as CubeType>::ExpandType

fn __expand_read_unchecked( scope: &mut Scope, this: Self::ExpandType, pos: <C as CubeType>::ExpandType, ) -> <T as CubeType>::ExpandType

fn __expand_to_linear_slice( scope: &mut Scope, this: Self::ExpandType, pos: <C as CubeType>::ExpandType, size: <C as CubeType>::ExpandType, ) -> <Slice<T> as CubeType>::ExpandType

fn __expand_tensor_map_load( scope: &mut Scope, this: Self::ExpandType, barrier: <Barrier as CubeType>::ExpandType, shared_memory: <Slice<T, ReadWrite> as CubeType>::ExpandType, pos: <C as CubeType>::ExpandType, ) -> <() as CubeType>::ExpandType

fn __expand_shape( scope: &mut Scope, this: Self::ExpandType, ) -> <C as CubeType>::ExpandType

fn __expand_is_in_bounds( scope: &mut Scope, this: Self::ExpandType, pos: <C as CubeType>::ExpandType, ) -> <bool as CubeType>::ExpandType

impl<T, N> ViewOperationsExpand<T, Sequence<N>> for ExpandElementTyped<TensorMap<T, Tiled>>

where T: CubePrimitive, N: CubePrimitive + Coordinates,

fn __expand_read_method( &self, _scope: &mut Scope, _pos: SequenceExpand<N>, ) -> <T as CubeType>::ExpandType

fn __expand_read_checked_method( &self, _scope: &mut Scope, _pos: SequenceExpand<N>, ) -> <T as CubeType>::ExpandType

fn __expand_read_masked_method( &self, _scope: &mut Scope, _pos: SequenceExpand<N>, _mask_value: <T as CubeType>::ExpandType, ) -> <T as CubeType>::ExpandType

fn __expand_read_unchecked_method( &self, _scope: &mut Scope, _pos: SequenceExpand<N>, ) -> <T as CubeType>::ExpandType

fn __expand_to_linear_slice_method( &self, _scope: &mut Scope, _pos: SequenceExpand<N>, _end: SequenceExpand<N>, ) -> SliceExpand<T, ReadOnly>

fn __expand_shape_method(&self, _scope: &mut Scope) -> SequenceExpand<N>

fn __expand_is_in_bounds_method( &self, _scope: &mut Scope, _pos: SequenceExpand<N>, ) -> ExpandElementTyped<bool>

fn __expand_tensor_map_load_method( &self, scope: &mut Scope, barrier: ExpandElementTyped<Barrier>, shared_memory: SliceExpand<T, ReadWrite>, pos: SequenceExpand<N>, )

impl<T, N> ViewOperationsMut<T, Sequence<N>> for TensorMap<T, Tiled>

where T: CubePrimitive, N: CubePrimitive + Coordinates,

fn write(&self, pos: C, value: T)

fn write_checked(&self, pos: C, value: T)

fn to_linear_slice_mut(&self, pos: C, size: C) -> Slice<T, ReadWrite>

Create a mutable slice starting from pos, with size. The layout handles translation into concrete indices.

fn tensor_map_store(&self, shared_memory: &Slice<T>, pos: C)

.Execute a TMA store into global memory, if the underlying storage supports it. Panics if it’s unsupported.

fn __expand_write( scope: &mut Scope, this: Self::ExpandType, pos: <C as CubeType>::ExpandType, value: <T as CubeType>::ExpandType, ) -> <() as CubeType>::ExpandType

fn __expand_write_checked( scope: &mut Scope, this: Self::ExpandType, pos: <C as CubeType>::ExpandType, value: <T as CubeType>::ExpandType, ) -> <() as CubeType>::ExpandType

fn __expand_to_linear_slice_mut( scope: &mut Scope, this: Self::ExpandType, pos: <C as CubeType>::ExpandType, size: <C as CubeType>::ExpandType, ) -> <Slice<T, ReadWrite> as CubeType>::ExpandType

fn __expand_tensor_map_store( scope: &mut Scope, this: Self::ExpandType, shared_memory: <Slice<T> as CubeType>::ExpandType, pos: <C as CubeType>::ExpandType, ) -> <() as CubeType>::ExpandType

impl<T, N> ViewOperationsMutExpand<T, Sequence<N>> for ExpandElementTyped<TensorMap<T, Tiled>>

where T: CubePrimitive, N: CubePrimitive + Coordinates,

fn __expand_write_method( &self, _scope: &mut Scope, _pos: SequenceExpand<N>, _value: <T as CubeType>::ExpandType, )

fn __expand_write_checked_method( &self, _scope: &mut Scope, _pos: SequenceExpand<N>, _value: <T as CubeType>::ExpandType, )

fn __expand_to_linear_slice_mut_method( &self, _scope: &mut Scope, _pos: SequenceExpand<N>, _end: SequenceExpand<N>, ) -> SliceExpand<T, ReadWrite>

fn __expand_tensor_map_store_method( &self, scope: &mut Scope, shared_memory: SliceExpand<T, ReadOnly>, pos: SequenceExpand<N>, )

impl<T> Eq for Sequence<T>

where T: Eq + CubeType,

impl<T> StructuralPartialEq for Sequence<T>

where T: CubeType,