Struct autograd::ops::gradient_descent_ops::StateKey

pub struct StateKey<'a>(pub &'a Tensor);

Key to access a state tensor. Stateful optimizers use this.

Trait Implementations

impl<'a> Eq for StateKey<'a>

impl<'a> PartialEq for StateKey<'a>

fn eq(&self, other: &StateKey<'a>) -> bool

Compares addresses of the two tensors. This can be used for ordering-based data structures (e.g. BinaryTree).

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

This method tests for !=.

impl<'a> Ord for StateKey<'a>

fn cmp(&self, other: &Self) -> Ordering

Compares addresses of the two tensors. This can be used for ordering-based data structures (e.g. BinaryTree).

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl<'a> PartialOrd for StateKey<'a>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

Compares addresses of the two tensors. This can be used for ordering-based data structures (e.g. BinaryTree).

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.