Skip to main content

ScanPlan

Struct ScanPlan 

Source
pub struct ScanPlan<T: Element, const N: usize> { /* private fields */ }
Expand description

Single-axis scan forward plan — see the module-level docs for formulas, dtypes, workspace, and precision guarantees.

T: Element is the element type (f32 / f64 / f16 / bf16). const N: usize is the tensor rank (1..=8).

Implementations§

Source§

impl<T: Element, const N: usize> ScanPlan<T, N>

Source

pub fn select( _stream: &Stream, desc: &ScanDescriptor<N>, _pref: PlanPreference, ) -> Result<Self>

Pick a kernel for desc. Validates scan_axis < N, the dtype is in the wired FP family, and tensor rank ≤ 8. Returns Error::Unsupported for cells outside the wired matrix.

Source

pub fn can_implement(&self, args: &ScanArgs<'_, T, N>) -> Result<()>

Validate args.

Source

pub fn workspace_size(&self) -> usize

Workspace size in bytes. Always zero.

Source

pub fn sku(&self) -> KernelSku

Identity of the kernel this plan picked.

Source

pub fn precision_guarantee(&self) -> PrecisionGuarantee

Numerical guarantees for this plan’s kernel — deterministic, bit-stable on the same hardware, f32 accumulator for f16 / bf16 inputs (FP detour).

Source

pub fn run( &self, stream: &Stream, _workspace: Workspace<'_>, args: ScanArgs<'_, T, N>, ) -> Result<()>

Launch the kernel against args. Calls can_implement first; returns Ok(()) for empty tensors.

Auto Trait Implementations§

§

impl<T, const N: usize> Freeze for ScanPlan<T, N>

§

impl<T, const N: usize> RefUnwindSafe for ScanPlan<T, N>
where T: RefUnwindSafe,

§

impl<T, const N: usize> Send for ScanPlan<T, N>
where T: Send,

§

impl<T, const N: usize> Sync for ScanPlan<T, N>
where T: Sync,

§

impl<T, const N: usize> Unpin for ScanPlan<T, N>
where T: Unpin,

§

impl<T, const N: usize> UnsafeUnpin for ScanPlan<T, N>

§

impl<T, const N: usize> UnwindSafe for ScanPlan<T, N>
where T: UnwindSafe,

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> 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, 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.