Struct DualTensor 

pub struct DualTensor<V: Differentiable> { /* private fields */ }

Value wrapper for forward-mode AD.

Examples

use chainrules::DualTensor;
let dual = DualTensor::new(primal);
assert!(!dual.has_tangent());

Implementations

impl<V: Differentiable> DualTensor<V>

pub fn new(primal: V) -> Self

Creates a dual value with zero tangent.

Examples

use chainrules::DualTensor;
let x = DualTensor::new(primal);

pub fn with_tangent(_primal: V, _tangent: V::Tangent) -> AdResult<Self>

Creates a dual value with explicit tangent.

Errors

Returns AutodiffError::TangentShapeMismatch if shapes differ.

Examples

use chainrules::DualTensor;
let x = DualTensor::with_tangent(primal, tangent).unwrap();

pub fn primal(&self) -> &V

Returns the primal value.

Examples

let p = dual.primal();

pub fn tangent(&self) -> Option<&V::Tangent>

Returns the tangent, or None for zero tangent.

Examples

let maybe_t = dual.tangent();

pub fn has_tangent(&self) -> bool

Returns whether this dual value has a non-zero tangent.

Examples

assert!(dual.has_tangent());

pub fn into_parts(self) -> (V, Option<V::Tangent>)

Consumes and returns (primal, tangent).

Examples

let (p, t) = dual.into_parts();

pub fn detach_tangent(self) -> Self

Consumes and returns a dual value with tangent removed.

Examples

let c = dual.detach_tangent();
assert!(!c.has_tangent());