Struct gad::store::GradientId

pub struct GradientId<T> { /* fields omitted */ }

A node Id associated with an underlying gradient type T. Such an association must assign a unique type to inner Id.

Trait Implementations

impl<T> Clone for GradientId<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Copy for GradientId<T>

impl<T> Debug for GradientId<T>

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

Formats the value using the given formatter.

impl<T> Eq for GradientId<T>

impl<T: 'static> GradientReader<GradientId<T>, T> for GenericGradientMap1

fn read(&self, id: GradientId<T>) -> Option<&T>

impl<T: 'static> GradientReader<GradientId<T>, T> for GenericGradientMapN

fn read(&self, id: GradientId<T>) -> Option<&T>

impl<T: 'static> GradientReader<GradientId<T>, Value<T>> for GenericGradientMapN

fn read(&self, id: GradientId<T>) -> Option<&Value<T>>

impl<T: 'static> GradientStore<GradientId<T>, T> for GenericGradientMap1

fn insert(&mut self, id: GradientId<T>, gradient: T)

fn get_mut(&mut self, id: GradientId<T>) -> Option<&mut T>

fn get(&self, id: Id) -> Option<&T>

fn add_gradient<A, G: ?Sized>(
    &mut self,
    graph: &mut G,
    id: Id,
    value: &T
) -> Result<()> where
    G: CoreAlgebra<A, Value = T>,
    Id: Copy,
    T: Clone + 'static, 

Update a gradient during backward propagation. This is used to define operators together with Graph::make_node. The parameter graph is used for higher-order differentials (see GraphN).

impl<T: 'static> GradientStore<GradientId<T>, Value<T>> for GenericGradientMapN

fn insert(&mut self, id: GradientId<T>, gradient: Value<T>)

fn get_mut(&mut self, id: GradientId<T>) -> Option<&mut Value<T>>

fn get(&self, id: Id) -> Option<&T>

fn add_gradient<A, G: ?Sized>(
    &mut self,
    graph: &mut G,
    id: Id,
    value: &T
) -> Result<()> where
    G: CoreAlgebra<A, Value = T>,
    Id: Copy,
    T: Clone + 'static, 

Update a gradient during backward propagation. This is used to define operators together with Graph::make_node. The parameter graph is used for higher-order differentials (see GraphN).

impl<T> Hash for GradientId<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T> PartialEq<GradientId<T>> for GradientId<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.