Struct quick_maths::autodiff::Var

pub struct Var { /* fields omitted */ }

A tracked variable which can be differentiated.

Implementations

impl Var

pub fn new(v: ScalarFloat) -> Self

Creates an instance of a variable

pub fn backwards(&self)

Computes the relationship of all variables used to this variable.

pub fn grad_wrt(&self) -> ScalarFloat

Returns the gradient of this variable w.r.t the variable that had backward most recently called on it.

Trait Implementations

impl Add<Var> for Var

type Output = Var

The resulting type after applying the + operator.

fn add(self, rhs: Var) -> Self::Output

Performs the + operation.

impl Add<f32> for Var

type Output = Var

The resulting type after applying the + operator.

fn add(self, rhs: ScalarFloat) -> Self::Output

Performs the + operation.

impl Clone for Var

fn clone(&self) -> Var

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Var

impl Debug for Var

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

Formats the value using the given formatter.

impl Div<Var> for Var

type Output = Var

The resulting type after applying the / operator.

fn div(self, rhs: Var) -> Self::Output

Performs the / operation.

impl Div<f32> for Var

type Output = Var

The resulting type after applying the / operator.

fn div(self, rhs: ScalarFloat) -> Self::Output

Performs the / operation.

impl Float for Var

fn nan() -> Self

Returns the NaN value.

fn infinity() -> Self

Returns the infinite value.

fn neg_infinity() -> Self

Returns the negative infinite value.

fn neg_zero() -> Self

Returns -0.0.

fn min_value() -> Self

Returns the smallest finite value that this type can represent.

fn max_value() -> Self

Returns the largest finite value that this type can represent.

fn min_positive_value() -> Self

Returns the smallest positive, normalized value that this type can represent.

fn ln(self) -> Self

Returns the natural logarithm of the number.

fn log2(self) -> Self

Returns the base 2 logarithm of the number.

fn log10(self) -> Self

Returns the base 10 logarithm of the number.

fn classify(self) -> FpCategory

Returns the floating point category of the number. If only one property is going to be tested, it is generally faster to use the specific predicate instead.

fn integer_decode(self) -> (u64, i16, i8)

Returns the mantissa, base 2 exponent, and sign as integers, respectively. The original number can be recovered by sign * mantissa * 2 ^ exponent.

fn mul_add(self, mul: Self, add: Self) -> Self

Fused multiply-add. Computes (self * a) + b with only one rounding error, yielding a more accurate result than an unfused multiply-add.

fn log(self, base: Self) -> Self

Taking the log w.r.t. an arbitrary base is currently unsupported So it assumes that base is fixed.

fn ln_1p(self) -> Self

Returns ln(1+n) (natural logarithm) more accurately than if the operations were performed separately.

fn exp(self) -> Self

Returns e^(self), (the exponential function).

fn exp2(self) -> Self

Returns 2^(self).

fn exp_m1(self) -> Self

Returns e^(self) - 1 in a way that is accurate even if the number is close to zero.

fn sqrt(self) -> Self

Take the square root of a number.

fn cbrt(self) -> Self

Take the cubic root of a number.

fn abs(self) -> Self

Computes the absolute value of self. Returns Float::nan() if the number is Float::nan().

fn abs_sub(self, o: Self) -> Self

The positive difference of two numbers.

fn sin(self) -> Self

Computes the sine of a number (in radians).

fn asin(self) -> Self

Computes the arcsine of a number. Return value is in radians in the range [-pi/2, pi/2] or NaN if the number is outside the range [-1, 1].

fn cos(self) -> Self

Computes the cosine of a number (in radians).

fn acos(self) -> Self

Computes the arccosine of a number. Return value is in radians in the range [0, pi] or NaN if the number is outside the range [-1, 1].

fn tan(self) -> Self

Computes the tangent of a number (in radians).

fn atan(self) -> Self

Computes the arctangent of a number. Return value is in radians in the range [-pi/2, pi/2];

fn sin_cos(self) -> (Self, Self)

Simultaneously computes the sine and cosine of the number, x. Returns (sin(x), cos(x)).

fn tanh(self) -> Self

Hyperbolic tangent function.

fn sinh(self) -> Self

Hyperbolic sine function.

fn cosh(self) -> Self

Hyperbolic cosine function.

fn hypot(self, o: Self) -> Self

Calculate the length of the hypotenuse of a right-angle triangle given legs of length x and y.

fn atan2(self, o: Self) -> Self

Computes the four quadrant arctangent of self (y) and other (x).

fn asinh(self) -> Self

Inverse hyperbolic sine function.

fn acosh(self) -> Self

Inverse hyperbolic cosine function.

fn atanh(self) -> Self

Inverse hyperbolic tangent function.

fn recip(self) -> Self

Take the reciprocal (inverse) of a number, 1/x.

fn floor(self) -> Self

Returns the largest integer less than or equal to a number.

fn ceil(self) -> Self

Returns the smallest integer greater than or equal to a number.

fn round(self) -> Self

Returns the nearest integer to a number. Round half-way cases away from 0.0.

fn signum(self) -> Self

Returns a number that represents the sign of self.

fn trunc(self) -> Self

Return the integer part of a number.

fn fract(self) -> Self

Returns the fractional part of a number.

fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

fn is_infinite(self) -> bool

Returns true if this value is positive infinity or negative infinity and false otherwise.

fn is_nan(self) -> bool

Returns true if this value is NaN and false otherwise.

fn is_sign_positive(self) -> bool

Returns true if self is positive, including +0.0, Float::infinity(), and since Rust 1.20 also Float::nan().

fn is_sign_negative(self) -> bool

Returns true if self is negative, including -0.0, Float::neg_infinity(), and since Rust 1.20 also -Float::nan().

fn is_normal(self) -> bool

Returns true if the number is neither zero, infinite, [subnormal][subnormal], or NaN.

fn powf(self, exp: Self) -> Self

Treats exp as a constant

fn powi(self, exp: i32) -> Self

Raise a number to an integer power.

fn max(self, o: Self) -> Self

Returns the maximum of the two numbers.

fn min(self, o: Self) -> Self

Returns the minimum of the two numbers.

fn epsilon() -> Self

Returns epsilon, a small positive value.

fn to_degrees(self) -> Self

Converts radians to degrees.

fn to_radians(self) -> Self

Converts degrees to radians.

impl Mul<Var> for Var

type Output = Var

The resulting type after applying the * operator.

fn mul(self, rhs: Var) -> Self::Output

Performs the * operation.

impl Mul<f32> for Var

type Output = Var

The resulting type after applying the * operator.

fn mul(self, rhs: ScalarFloat) -> Self::Output

Performs the * operation.

impl Neg for Var

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Num for Var

type FromStrRadixErr = ()

fn from_str_radix(_s: &str, _radix: u32) -> Result<Self, Self::FromStrRadixErr>

Convert from a string and radix <= 36.

impl NumCast for Var

fn from<T: ToPrimitive>(n: T) -> Option<Self>

Creates a number from another value that can be converted into a primitive via the ToPrimitive trait. If the source value cannot be represented by the target type, then None is returned.

impl One for Var

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

impl PartialEq<Var> for Var

fn eq(&self, o: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Var> for Var

fn partial_cmp(&self, o: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Rem<Var> for Var

type Output = Var

The resulting type after applying the % operator.

fn rem(self, rhs: Var) -> Self::Output

Performs the % operation.

impl Rem<f32> for Var

type Output = Var

The resulting type after applying the % operator.

fn rem(self, rhs: ScalarFloat) -> Self::Output

Performs the % operation.

impl Sub<Var> for Var

type Output = Var

The resulting type after applying the - operator.

fn sub(self, rhs: Var) -> Self::Output

Performs the - operation.

impl Sub<f32> for Var

type Output = Var

The resulting type after applying the - operator.

fn sub(self, rhs: ScalarFloat) -> Self::Output

Performs the - operation.

impl ToPrimitive for Var

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. If the value cannot be represented by an f32, then None is returned.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. If the value cannot be represented by an f64, then None is returned.

impl Zero for Var

fn zero() -> Self

Returns the additive identity element of Self, 0. # Purity

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.