Struct gad::Eval

pub struct Eval { /* fields omitted */ }

The default algebra that only computes forward values.

Implementations

impl Eval

pub fn check(&mut self) -> &mut Check

Access the underlying default “Check” algebra.

Trait Implementations

impl<T: Float> AfAlgebra<T> for Eval

type Scalar = T

type Value = Array<T>

type GradientReader = EmptyGradientMap

impl<T> AnalyticAlgebra<Array<T>> for Eval where
    Self: CoreAlgebra<Array<T>, Value = Array<T>>,
    T: HasAfEnum<UnaryOutType = T, AbsOutType = T> + ImplicitPromote<T, Output = T> + ConstGenerator<OutType = T> + Zero + One + for<'a> Div<&'a Array<T>, Output = Array<T>>, 

fn exp(&mut self, v: &Array<T>) -> Array<T>

Element-wise natural logarithm exp(x).

fn log(&mut self, v: &Array<T>) -> Array<T>

Element-wise natural logarithm log(x).

fn log1p(&mut self, v: &Array<T>) -> Array<T>

Element-wise natural logarithm shifted by one log(1 + x).

fn sin(&mut self, v: &Array<T>) -> Array<T>

Element-wise sinus sin(x).

fn cos(&mut self, v: &Array<T>) -> Array<T>

Element-wise cosinus cos(x).

fn tanh(&mut self, v: &Array<T>) -> Array<T>

Element-wise hyperbolic tangent tanh(x).

fn sigmoid(&mut self, v: &Array<T>) -> Array<T>

Element-wise sigmoid 1 / (1 + exp(-x)).

fn reciprocal(&mut self, v: &Array<T>) -> Array<T>

Element-wise reciprocal 1/x.

fn sqrt(&mut self, v: &Array<T>) -> Array<T>

Element-wise square root sqrt(x).

fn div(&mut self, v0: &Array<T>, v1: &Array<T>) -> Result<Array<T>>

Element-wise division x / y.

fn pow(&mut self, v0: &Array<T>, v1: &Array<T>) -> Result<Array<T>>

Element-wise power x ^ p.

impl<T> AnalyticAlgebra<T> for Eval where
    T: Number + Float, 

fn exp(&mut self, v: &T) -> T

Element-wise natural logarithm exp(x).

fn log(&mut self, v: &T) -> T

Element-wise natural logarithm log(x).

fn log1p(&mut self, v: &T) -> T

Element-wise natural logarithm shifted by one log(1 + x).

fn sin(&mut self, v: &T) -> T

Element-wise sinus sin(x).

fn cos(&mut self, v: &T) -> T

Element-wise cosinus cos(x).

fn tanh(&mut self, v: &T) -> T

Element-wise hyperbolic tangent tanh(x).

fn sigmoid(&mut self, v: &T) -> T

Element-wise sigmoid 1 / (1 + exp(-x)).

fn reciprocal(&mut self, v: &T) -> T

Element-wise reciprocal 1/x.

fn sqrt(&mut self, v: &T) -> T

Element-wise square root sqrt(x).

fn div(&mut self, v0: &T, v1: &T) -> Result<T>

Element-wise division x / y.

fn pow(&mut self, v0: &T, v1: &T) -> Result<T>

Element-wise power x ^ p.

impl<T> ArithAlgebra<Array<T>> for Eval where
    Self: CoreAlgebra<Array<T>, Value = Array<T>>,
    T: HasAfEnum + ImplicitPromote<T, Output = T> + ConstGenerator<OutType = T> + Zero + One, 

fn zeros(&mut self, v: &Array<T>) -> Array<T>

Element-wise zero (same dimensions as v).

fn ones(&mut self, v: &Array<T>) -> Array<T>

Element-wise one (same dimensions as v).

fn neg(&mut self, v: &Array<T>) -> Array<T>

Element-wise negation -v

fn sub(&mut self, v0: &Array<T>, v1: &Array<T>) -> Result<Array<T>>

Element-wise subtraction v0 - v1

fn mul(&mut self, v0: &Array<T>, v1: &Array<T>) -> Result<Array<T>>

Element-wise multiplication v0 * v1

impl<T: Number> ArithAlgebra<T> for Eval

fn zeros(&mut self, _v: &T) -> T

Element-wise zero (same dimensions as v).

fn ones(&mut self, _v: &T) -> T

Element-wise one (same dimensions as v).

fn neg(&mut self, v: &T) -> T

Element-wise negation -v

fn sub(&mut self, v0: &T, v1: &T) -> Result<T>

Element-wise subtraction v0 - v1

fn mul(&mut self, v0: &T, v1: &T) -> Result<T>

Element-wise multiplication v0 * v1

impl<T> ArrayAlgebra<Array<T>> for Eval where
    T: Float, 

type Dims = Dim4

type Scalar = T

fn flat(&mut self, v: &Array<T>) -> Array<T>

Re-shape the input into a single dimension array.

fn moddims(&mut self, v: &Array<T>, dims: Dim4) -> Result<Array<T>>

Re-shape the input into an array of the given dimensions.

fn tile_as(&mut self, v: &Array<T>, rdims: Dim4) -> Result<Array<T>>

Repeats the input to match the given shape.

fn sum_as(&mut self, v: &Array<T>, rdims: Dim4) -> Result<Array<T>>

Sums some of the dimension of the input to fit the given shape.

fn constant_as(&mut self, v: &T, dims: Dim4) -> Array<T>

Fill an array of the given shape with the given scalar value.

fn as_scalar(&mut self, v: &Array<T>) -> Result<T>

Read the scalar value in a one-element array.

fn scale(&mut self, lambda: &T, v: &Array<T>) -> Array<T>

Multiply the array element-wise by the given scalar.

fn dot(&mut self, v1: &Array<T>, v2: &Array<T>) -> Result<T>

Compute the dot-product of two arrays of the same shape.

fn norm2(&mut self, v: &Value) -> Self::Scalar

Compute the L2-norm of an array.

impl<T> ArrayCompareAlgebra<Array<T>> for Eval where
    Self: CoreAlgebra<Array<T>, Value = Array<T>> + AnalyticAlgebra<Array<T>>,
    T: Float + ImplicitPromote<T, Output = T> + ConstGenerator<OutType = T> + Zero, 

fn max_as(&mut self, v: &Array<T>, rdims: Dim4) -> Result<Array<T>>

fn argmax_as(&mut self, v: &Array<T>, rdims: Dim4) -> Result<Array<T>>

fn softmax_as(&mut self, v: &Array<T>, rdims: Dim4) -> Result<Array<T>>

impl Clone for Eval

fn clone(&self) -> Eval

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> CompareAlgebra<Array<T>> for Eval where
    Self: CoreAlgebra<Array<T>, Value = Array<T>>,
    T: HasAfEnum + ImplicitPromote<T, Output = T> + ConstGenerator<OutType = T> + Zero, 

fn min(&mut self, v0: &Array<T>, v1: &Array<T>) -> Result<Array<T>>

Element-wise minimum min(v0, v1).

fn max(&mut self, v0: &Array<T>, v1: &Array<T>) -> Result<Array<T>>

Element-wise maximum max(v0, v1).

fn select_argmax(
    &mut self,
    v0: &Array<T>,
    v1: &Array<T>,
    r0: Option<&Array<T>>,
    r1: Option<&Array<T>>
) -> Result<Array<T>>

Element-wise selection by comparison: if v0 >= v1 then r0 else r1 None arguments are taken as zeroes.

fn abs(&mut self, v: &Value) -> Value where
    Self: ArithAlgebra<Value>, 

Element-wise absolute value |v|.

fn sign(&mut self, v: &Value) -> Value where
    Self: ArithAlgebra<Value>, 

Element-wise sign value sign(v).

fn relu(&mut self, v: &Value) -> Value where
    Self: ArithAlgebra<Value>, 

Element-wise value relu(v) = max(v, 0).

impl<T: Number + PartialOrd> CompareAlgebra<T> for Eval

fn min(&mut self, v0: &T, v1: &T) -> Result<T>

Element-wise minimum min(v0, v1).

fn max(&mut self, v0: &T, v1: &T) -> Result<T>

Element-wise maximum max(v0, v1).

fn select_argmax(
    &mut self,
    v0: &T,
    v1: &T,
    r0: Option<&T>,
    r1: Option<&T>
) -> Result<T>

Element-wise selection by comparison: if v0 >= v1 then r0 else r1 None arguments are taken as zeroes.

fn abs(&mut self, v: &Value) -> Value where
    Self: ArithAlgebra<Value>, 

Element-wise absolute value |v|.

fn sign(&mut self, v: &Value) -> Value where
    Self: ArithAlgebra<Value>, 

Element-wise sign value sign(v).

fn relu(&mut self, v: &Value) -> Value where
    Self: ArithAlgebra<Value>, 

Element-wise value relu(v) = max(v, 0).

impl<T, C> ConstArithAlgebra<Array<T>, C> for Eval where
    Self: CoreAlgebra<Array<T>, Value = Array<T>>,
    T: HasAfEnum + ImplicitPromote<T, Output = T> + ConstGenerator<OutType = T> + From<C>, 

fn setc(&mut self, v: &Array<T>, c: C) -> Array<T>

Return a value with the same shape as v but filled with constant c.

fn addc(&mut self, v: &Array<T>, c: C) -> Array<T>

Element-wise addition of a constant v + c.

fn mulc(&mut self, v: &Array<T>, c: C) -> Array<T>

Element-wise multiplication by a constant v * c.

fn powc(&mut self, v: &Array<T>, c: C) -> Array<T>

Element-wise exponentiation by a constant v ^ c.

impl<T, C> ConstArithAlgebra<T, C> for Eval where
    T: Number + From<C> + Pow<C, Output = T>, 

fn setc(&mut self, _v: &T, c: C) -> T

Return a value with the same shape as v but filled with constant c.

fn addc(&mut self, v: &T, c: C) -> T

Element-wise addition of a constant v + c.

fn mulc(&mut self, v: &T, c: C) -> T

Element-wise multiplication by a constant v * c.

fn powc(&mut self, v: &T, c: C) -> T

Element-wise exponentiation by a constant v ^ c.

impl<T> CoreAlgebra<Array<T>> for Eval where
    T: HasAfEnum + ImplicitPromote<T, Output = T>, 

type Value = Array<T>

Tracked values of underlying type Data.

fn variable(&mut self, array: Array<T>) -> Array<T>

A differential input to the computation.

fn constant(&mut self, array: Array<T>) -> Array<T>

A non-differential input to the computation.

fn add(&mut self, v0: &Array<T>, v1: &Array<T>) -> Result<Array<T>>

Compute the sum of two values v1 + v2.

fn add_all(&mut self, values: &[&Self::Value]) -> Result<Self::Value> where
    Self::Value: Clone, 

Compute the sum of several values.

impl<T: Number> CoreAlgebra<T> for Eval

type Value = T

Tracked values of underlying type Data.

fn variable(&mut self, data: T) -> T

A differential input to the computation.

fn constant(&mut self, data: T) -> T

A non-differential input to the computation.

fn add(&mut self, v0: &T, v1: &T) -> Result<T>

Compute the sum of two values v1 + v2.

fn add_all(&mut self, values: &[&Self::Value]) -> Result<Self::Value> where
    Self::Value: Clone, 

Compute the sum of several values.

impl Default for Eval

fn default() -> Eval

Returns the “default value” for a type.

impl FullAlgebra for Eval

type GradientReader = EmptyGradientMap

impl HasGradientReader for Eval

type GradientReader = EmptyGradientMap

impl<T> MatrixAlgebra<Array<T>> for Eval where
    T: Float, 

fn matmul(
    &mut self,
    v1: &Array<T>,
    v2: &Array<T>,
    prop1: MatProp,
    prop2: MatProp
) -> Result<Array<T>>

Multiplication of two matrices after some optional transpositions.

fn transpose(&mut self, v: &Array<T>, conjugate: bool) -> Result<Array<T>>

Transpose (and optionally conjuguate) a matrix.

fn matmul_nn(&mut self, v1: &Value, v2: &Value) -> Result<Value>

Non-transposed multiplication of two matrices.