Skip to main content

ScanKind

Enum ScanKind 

Source
#[non_exhaustive]
#[repr(u16)]
pub enum ScanKind { Cumsum = 0, Cumprod = 1, Cummax = 2, Cummin = 3, LogCumsumExp = 4, }
Expand description

Scan (associative prefix) op discriminant — category F from the comprehensive plan.

Stored as u16 in crate::KernelSku::op when category == OpCategory::Scan. Output shape equals input shape — scans are length-preserving along the scan axis (in contrast with reductions, which collapse the axis to size 1). Inclusive scan by default (PyTorch convention: y[i] = op(x[0], x[1], …, x[i])). Direction is controlled by the descriptor’s reverse flag.

Today wired: {Cumsum} × {f32, f16, bf16, f64} (FW + BW) as the scan trailblazer. Cumprod / Cummax / Cummin land in fanout; LogCumsumExp and the JAX-style generic associative_scan are reserved-but-deferred (numerics / generic-functor work).

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Cumsum = 0

y[i] = Σ_{j ≤ i} x[j] — inclusive prefix sum.

§

Cumprod = 1

y[i] = ∏_{j ≤ i} x[j] — inclusive prefix product.

§

Cummax = 2

y[i] = max(x[0..=i]) — running maximum.

§

Cummin = 3

y[i] = min(x[0..=i]) — running minimum.

§

LogCumsumExp = 4

y[i] = log(Σ_{j ≤ i} exp(x[j])) — numerically stable (running max subtraction). Reserved.

Trait Implementations§

Source§

impl Clone for ScanKind

Source§

fn clone(&self) -> ScanKind

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ScanKind

Source§

impl Debug for ScanKind

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ScanKind

Source§

impl Hash for ScanKind

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ScanKind

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ScanKind

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.