Struct Gradients 

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

Accumulated gradients indexed by NodeId.

Examples

use chainrules::{Gradients, Differentiable};
// V::Tangent is the gradient type
let mut grads = Gradients::<MyType>::new();

Implementations

impl<V: Differentiable> Gradients<V>

pub fn new() -> Self

Creates an empty gradient container.

Examples

use chainrules::Gradients;
let grads = Gradients::<MyType>::new();

pub fn get(&self, _node: NodeId) -> Option<&V::Tangent>

Returns the gradient for node, if present.

Examples

if let Some(g) = grads.get(node) {
    // use gradient
}

pub fn accumulate(&mut self, _node: NodeId, _grad: V::Tangent) -> AdResult<()>

Inserts or accumulates a gradient for node.

Examples

grads.accumulate(node, grad);

pub fn entries(&self) -> &[(NodeId, V::Tangent)]

Returns all (node, grad) entries.

Examples

for (node, grad) in grads.entries() {
    println!("{}", node.index());
}

Trait Implementations

impl<V: Differentiable> Default for Gradients<V>

fn default() -> Self

Returns the “default value” for a type.