Struct Tape 

pub struct Tape<F: IntegrateFloat> { /* private fields */ }

Reverse mode AD tape for recording operations

Implementations

impl<F: IntegrateFloat> Tape<F>

pub fn new() -> Self

Create a new tape

pub fn variable(&mut self, idx: usize, value: F) -> usize

Add a variable to the tape

pub fn constant(&mut self, value: F) -> usize

Add a constant to the tape

pub fn add(&mut self, a: usize, b: usize) -> usize

Record addition

pub fn sub(&mut self, a: usize, b: usize) -> usize

Record subtraction

pub fn mul(&mut self, a: usize, b: usize) -> usize

Record multiplication

pub fn div(&mut self, a: usize, b: usize) -> usize

Record division

pub fn neg(&mut self, a: usize) -> usize

Record negation

pub fn pow(&mut self, a: usize, n: F) -> usize

Record power

pub fn sin(&mut self, a: usize) -> usize

Record sin

pub fn cos(&mut self, a: usize) -> usize

Record cos

pub fn exp(&mut self, a: usize) -> usize

Record exp

pub fn ln(&mut self, a: usize) -> usize

Record ln

pub fn sqrt(&mut self, a: usize) -> usize

Record sqrt

pub fn pow_general(&mut self, a: usize, b: usize) -> usize

Record general power where both base and exponent are variables

pub fn tan(&mut self, a: usize) -> usize

Record tan

pub fn tanh(&mut self, a: usize) -> usize

Record tanh

pub fn sinh(&mut self, a: usize) -> usize

Record sinh

pub fn cosh(&mut self, a: usize) -> usize

Record cosh

pub fn atan2(&mut self, y: usize, x: usize) -> usize

Record atan2

pub fn abs(&mut self, a: usize) -> usize

Record abs

pub fn max(&mut self, a: usize, b: usize) -> usize

Record max

pub fn min(&mut self, a: usize, b: usize) -> usize

Record min

pub fn value(&self, idx: usize) -> F

Get the value at a node

pub fn backward(&mut self, outputidx: usize, nvars: usize) -> Array1<F>

Backward pass to compute gradients

Trait Implementations

impl<F: IntegrateFloat> Default for Tape<F>

fn default() -> Self

Returns the “default value” for a type.