Skip to main content

BinaryPlan

Struct BinaryPlan 

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

Binary elementwise plan.

T: Element is the kernel’s element type (today: must be f32). const N: usize is the tensor rank — fixed at compile time to keep the descriptor heap-free and the rank invariants type-checked.

Implementations§

Source§

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

Source

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

Pick a kernel for desc. Returns Error::Unsupported if the (kind, T::KIND) pair isn’t wired today.

Source

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

Validate that this plan can launch with args.

Accepts both fully-contiguous operands (which take the contig fast path) and broadcast / strided operands (which take the strided path). For each axis d, each input operand must satisfy shape[d] == y.shape[d] (no broadcast on that axis) or shape[d] == 1 && stride[d] == 0 (broadcast on that axis). The output must be exactly desc.shape and is conventionally contiguous, though the strided kernel accepts arbitrary y strides too.

Source

pub fn workspace_size(&self) -> usize

Workspace size in bytes. Always 0 for the trailblazer SKU.

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.

Source

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

Launch.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

§

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