Skip to main content

RollPlan

Struct RollPlan 

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

roll plan.

y = x.roll(shifts, axes) — cyclic shift along axes (PyTorch torch.roll). Output shape equals input shape.

When to use: forward cyclic shift. Pair with RollBackwardPlan, which reuses the FW kernel with negated shifts.

Dtypes: {f32, f64, f16, bf16}. Pure index permutation.

Shape limits: rank in [1, 8]; per-axis shifts can be negative (kernel normalizes to [0, shape[d])).

Workspace: none.

Precision guarantee: deterministic, bit-stable, bit-exact.

Implementations§

Source§

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

Source

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

Pick a kernel for desc.

Source

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

Validate args.

Source

pub fn workspace_size(&self) -> usize

Workspace size in bytes.

Source

pub fn sku(&self) -> KernelSku

Identity of the kernel this plan picked.

Source

pub fn precision_guarantee(&self) -> PrecisionGuarantee

Numerical guarantees.

Source

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

Launch.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

§

impl<T, const N: usize> UnwindSafe for RollPlan<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.