Struct CustomFunction

Source

pub struct CustomFunction<I, O> { /* private fields */ }

Expand description

A function of a tree with custom transform rules; see custom_function.

Implementations§

Source §

impl<I, O> CustomFunction<I, O>
where I: Tree + Send + Sync, O: Tree + Send + Sync,

Source

pub fn with_vjp( self, rule: impl Fn(&I, &O, &O) -> Result + Send + Sync + 'static, ) -> Self

Sets the reverse-mode rule: (primals, outputs, cotangents) → the cotangent of the primals (a tree like them).

Source

pub fn with_jvp( self, rule: impl Fn(&I, &I) -> Result<O> + Send + Sync + 'static, ) -> Self

Sets the forward-mode rule: (primals, tangents) → the outputs’ tangents (missing input tangents are passed as zeros).

Source

pub fn with_vmap( self, rule: impl Fn(&I, &[Option<i32>]) -> Result<(O, i32)> + Send + Sync + 'static, ) -> Self

Sets the batching rule: (inputs, batch axis of each input leaf) (None for unbatched leaves) → the batched outputs and their common batch axis.

Source

pub fn call(&self, inputs: &I) -> Result<O>

Calls the function on inputs. Values equal f(inputs); transforms of the results use the custom rules.

Trait Implementations§

Source §

impl<I, O> Clone for CustomFunction<I, O>

Source §

fn clone(&self) -> Self

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

Auto Trait Implementations§

§

impl<I, O> !RefUnwindSafe for CustomFunction<I, O>

§

impl<I, O> !UnwindSafe for CustomFunction<I, O>

§

impl<I, O> Freeze for CustomFunction<I, O>
where Arc<dyn Fn(&I) -> Result<O, Error> + Send + Sync>: Freeze, Option<Arc<dyn Fn(&I, &O, &O) -> Result<I, Error> + Send + Sync>>: Freeze, Option<Arc<dyn Fn(&I, &I) -> Result<O, Error> + Send + Sync>>: Freeze, Option<Arc<dyn Fn(&I, &[Option<i32>]) -> Result<(O, i32), Error> + Send + Sync>>: Freeze,

§

impl<I, O> Send for CustomFunction<I, O>
where Arc<dyn Fn(&I) -> Result<O, Error> + Send + Sync>: Send, Option<Arc<dyn Fn(&I, &O, &O) -> Result<I, Error> + Send + Sync>>: Send, Option<Arc<dyn Fn(&I, &I) -> Result<O, Error> + Send + Sync>>: Send, Option<Arc<dyn Fn(&I, &[Option<i32>]) -> Result<(O, i32), Error> + Send + Sync>>: Send,

§

impl<I, O> Sync for CustomFunction<I, O>
where Arc<dyn Fn(&I) -> Result<O, Error> + Send + Sync>: Sync, Option<Arc<dyn Fn(&I, &O, &O) -> Result<I, Error> + Send + Sync>>: Sync, Option<Arc<dyn Fn(&I, &I) -> Result<O, Error> + Send + Sync>>: Sync, Option<Arc<dyn Fn(&I, &[Option<i32>]) -> Result<(O, i32), Error> + Send + Sync>>: Sync,

§

impl<I, O> Unpin for CustomFunction<I, O>
where Arc<dyn Fn(&I) -> Result<O, Error> + Send + Sync>: Unpin, Option<Arc<dyn Fn(&I, &O, &O) -> Result<I, Error> + Send + Sync>>: Unpin, Option<Arc<dyn Fn(&I, &I) -> Result<O, Error> + Send + Sync>>: Unpin, Option<Arc<dyn Fn(&I, &[Option<i32>]) -> Result<(O, i32), Error> + Send + Sync>>: Unpin,

§

impl<I, O> UnsafeUnpin for CustomFunction<I, O>
where Arc<dyn Fn(&I) -> Result<O, Error> + Send + Sync>: UnsafeUnpin, Option<Arc<dyn Fn(&I, &O, &O) -> Result<I, Error> + Send + Sync>>: UnsafeUnpin, Option<Arc<dyn Fn(&I, &I) -> Result<O, Error> + Send + Sync>>: UnsafeUnpin, Option<Arc<dyn Fn(&I, &[Option<i32>]) -> Result<(O, i32), Error> + Send + Sync>>: UnsafeUnpin,

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> AutoreleaseSafe for T
where T: ?Sized,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §