Skip to main content

Var

Struct Var 

Source
pub struct Var<'t> { /* private fields */ }
Expand description

A differentiable value: a Copy handle carrying its numeric value and its position on the Tape.

Implementations§

Source§

impl<'t> Var<'t>

Source

pub fn value(&self) -> f64

The current numeric value.

Source

pub fn backward(&self) -> Grad

Reverse pass seeded at self: returns ∂self/∂· for every node. Cost is O(#nodes), one linear sweep.

Source

pub fn sin(self) -> Var<'t>

Sine (d/dx sin x = cos x).

Source

pub fn cos(self) -> Var<'t>

Cosine (d/dx cos x = −sin x).

Source

pub fn exp(self) -> Var<'t>

Exponential (d/dx eˣ = eˣ).

Source

pub fn ln(self) -> Var<'t>

Natural log (d/dx ln x = 1/x).

Source

pub fn tanh(self) -> Var<'t>

Hyperbolic tangent (d/dx tanh x = 1 − tanh²x) — the workhorse network activation.

Source

pub fn sqrt(self) -> Var<'t>

Square root (d/dx √x = 1/(2√x)).

Source

pub fn powf(self, n: f64) -> Var<'t>

Integer/real power (d/dx xⁿ = n·xⁿ⁻¹).

Source

pub fn sigmoid(self) -> Var<'t>

Logistic sigmoid σ(x) = 1/(1+e⁻ˣ) (σ' = σ(1−σ)).

Source

pub fn relu(self) -> Var<'t>

Rectified linear unit (ReLU' = [x>0]).

Trait Implementations§

Source§

impl<'t> Add for Var<'t>

Source§

type Output = Var<'t>

The resulting type after applying the + operator.
Source§

fn add(self, rhs: Var<'t>) -> Var<'t>

Performs the + operation. Read more
Source§

impl<'t> Add<f64> for Var<'t>

Source§

type Output = Var<'t>

The resulting type after applying the + operator.
Source§

fn add(self, rhs: f64) -> Var<'t>

Performs the + operation. Read more
Source§

impl<'t> Clone for Var<'t>

Source§

fn clone(&self) -> Var<'t>

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<'t> Copy for Var<'t>

Source§

impl<'t> Div for Var<'t>

Source§

type Output = Var<'t>

The resulting type after applying the / operator.
Source§

fn div(self, rhs: Var<'t>) -> Var<'t>

Performs the / operation. Read more
Source§

impl<'t> Mul for Var<'t>

Source§

type Output = Var<'t>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: Var<'t>) -> Var<'t>

Performs the * operation. Read more
Source§

impl<'t> Mul<f64> for Var<'t>

Source§

type Output = Var<'t>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: f64) -> Var<'t>

Performs the * operation. Read more
Source§

impl<'t> Neg for Var<'t>

Source§

type Output = Var<'t>

The resulting type after applying the - operator.
Source§

fn neg(self) -> Var<'t>

Performs the unary - operation. Read more
Source§

impl<'t> Sub for Var<'t>

Source§

type Output = Var<'t>

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: Var<'t>) -> Var<'t>

Performs the - operation. Read more
Source§

impl<'t> Sub<f64> for Var<'t>

Source§

type Output = Var<'t>

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: f64) -> Var<'t>

Performs the - operation. Read more

Auto Trait Implementations§

§

impl<'t> !RefUnwindSafe for Var<'t>

§

impl<'t> !Send for Var<'t>

§

impl<'t> !Sync for Var<'t>

§

impl<'t> !UnwindSafe for Var<'t>

§

impl<'t> Freeze for Var<'t>

§

impl<'t> Unpin for Var<'t>

§

impl<'t> UnsafeUnpin for Var<'t>

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

Source§

fn by_ref(&self) -> &T

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> ClosedNeg for T
where T: Neg<Output = T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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> 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§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.