Struct reverse::Tape

pub struct Tape { /* fields omitted */ }

Tape (Wengert list) that tracks differentiable variables, intermediate values, and the operations applied to each.

Implementations

impl Tape

pub fn new() -> Self

Create a new tape.

pub fn len(&self) -> usize

Gets the number of nodes (differentiable variables and intermediate values) in the tape.

pub fn is_empty(&self) -> bool

Checks whether the tape is empty.

pub fn add_var(&self, val: f64) -> Var<'_>

Add a variable with value val to the tape. Returns a Var<'a> which can be used like an f64.

pub fn add_vars<'a>(&'a self, vals: &[f64]) -> Vec<Var<'a>>

Add a slice of variables to the tape. See add_var for details.

pub fn zero_grad(&self)

Zero out all the gradients in the tape.

pub fn clear(&self)

Clear the tape by deleting all nodes (useful for clearing out intermediate values).

Trait Implementations

impl Clone for Tape

fn clone(&self) -> Tape

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tape

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

Formats the value using the given formatter.

impl Default for Tape

fn default() -> Self

Returns the “default value” for a type.