Struct Sequence

pub struct Sequence<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: CubeType + Clone> Sequence<T>

pub fn rev(&self) -> Self

impl<T: CubeType> Sequence<T>

pub fn new() -> Self

Create a new empty sequence.

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

Push a new value into the sequence.

pub fn len(&self) -> u32

Obtain the sequence length.

pub fn index<I: Index>(&self, index: I) -> &T

Get the variable at the given position in the sequence.

pub fn index_mut<I: Index>(&mut self, index: I) -> &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<I: Index>(&mut self, index: I, value: T)

Insert an item at the given index.

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

Expand function of push.

pub fn __expand_index( scope: &mut Scope, expand: SequenceExpand<T>, index: ExpandElementTyped<u32>, ) -> T::ExpandType

Expand function of index.

pub fn __expand_index_mut( scope: &mut Scope, expand: SequenceExpand<T>, index: ExpandElementTyped<u32>, ) -> T::ExpandType

Expand function of index_mut.

Trait Implementations

impl<T: Clone + CubeType> Clone for Sequence<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: CubeType> CubeDebug for Sequence<T>

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: CubeType> CubeType for Sequence<T>

type ExpandType = SequenceExpand<T>

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

Wrapper around the init method, necessary to type inference.

impl<T: Debug + CubeType> Debug for Sequence<T>

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

Formats the value using the given formatter.

impl<T: CubeType> Default for Sequence<T>

fn default() -> Self

Returns the “default value” for a type.

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

where T: Deserialize<'de> + CubeType,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Hash + CubeType> Hash for Sequence<T>

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<T: CubeType> Init for Sequence<T>

fn init(self, _scope: &mut Scope) -> Self

Initialize a type within a scope.

impl<T: CubeType> IntoIterator for Sequence<T>

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) -> Self::IntoIter

Creates an iterator from a value.

impl<C: LaunchArg> LaunchArg for Sequence<C>

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

The runtime argument for the kernel.

fn compilation_arg<R: Runtime>( runtime_arg: &Self::RuntimeArg<'_, R>, ) -> Self::CompilationArg

impl<C: LaunchArg> LaunchArgExpand for Sequence<C>

type CompilationArg = SequenceCompilationArg<C>

Compilation argument.

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

Register an input variable during compilation that fill the KernelBuilder.

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

Register an output variable during compilation that fill the KernelBuilder.

impl<T: Ord + CubeType> Ord for Sequence<T>

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 + CubeType> PartialEq for Sequence<T>

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 + CubeType> PartialOrd for Sequence<T>

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: Serialize + CubeType,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq + CubeType> Eq for Sequence<T>

impl<T: CubeType> StructuralPartialEq for Sequence<T>