Skip to main content

KernelIrBuilder

Struct KernelIrBuilder 

Source
pub struct KernelIrBuilder { /* private fields */ }
Expand description

Builder for appending type-checked instructions to existing scalar IR.

Implementations§

Source§

impl KernelIrBuilder

Source

pub fn from_scalar(ir: &ScalarKernelIr) -> Self

Creates a builder initialized with a scalar kernel’s values.

Source

pub fn push( &mut self, instruction: KernelInstruction, ) -> Result<KernelValueId, KernelIrError>

Appends an instruction after validating its operands and inferred type.

§Errors

Returns KernelIrError when an operand does not precede the new instruction, the operand shapes are incompatible, or the instruction’s value kind cannot be inferred.

Source

pub fn finish_gradient( self, primal_root: KernelValueId, outputs: Vec<KernelValueId>, component: OutputComponent, ) -> Result<GradientKernelIr, KernelIrError>

Finishes the builder as a validated gradient kernel.

§Errors

Returns KernelIrError when the accumulated primal IR is invalid, primal_root is not scalar, a gradient output is out of bounds, or a gradient output is not real-valued.

Source

pub fn values(&self) -> &[KernelValue]

Returns the values accumulated so far.

Trait Implementations§

Source§

impl Clone for KernelIrBuilder

Source§

fn clone(&self) -> KernelIrBuilder

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 Debug for KernelIrBuilder

Source§

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

Formats the value using the given formatter. Read more

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.