Struct easy_ml::differentiation::Derivatives[][src]

pub struct Derivatives<T> { /* fields omitted */ }

Computed derivatives of a computational graph for some output Record variable.

This can be indexed by any Record used in the computational graph to get the derivative with respect to that input.

Indexing using Records not involved in the computational graph, or involved in a different one will return nonsense or index out of bounds and panic. In the future this may be changed to always panic.

Implementations

impl<T: Clone + Primitive> Derivatives<T>[src]

pub fn at(&self, input: &Record<'_, T>) -> T[src]

Quries the derivative at the provided record as input.

If you construct a Derivatives object for some output y, and call .at(&x) on it for some input x, this returns dy/dx.

Trait Implementations

impl<T: Clone> Clone for Derivatives<T>[src]

Any derivatives of a Cloneable type implements clone

fn clone(&self) -> Self[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for Derivatives<T>[src]

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

Formats the value using the given formatter. Read more

impl<'a, T: Primitive> Index<&'_ Record<'a, T>> for Derivatives<T>[src]

fn index(&self, input: &Record<'a, T>) -> &Self::Output[src]

Quries the derivative at the provided record as input.

If you construct a Derivatives object for some output y, and call .at(&x) on it for some input x, this returns dy/dx.

type Output = T

The returned type after indexing.

Auto Trait Implementations

impl<T> RefUnwindSafe for Derivatives<T> where
    T: RefUnwindSafe

impl<T> Send for Derivatives<T> where
    T: Send

impl<T> Sync for Derivatives<T> where
    T: Sync

impl<T> Unpin for Derivatives<T> where
    T: Unpin

impl<T> UnwindSafe for Derivatives<T> where
    T: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.