Struct Variable

Source

pub struct Variable { /* private fields */ }

Expand description

Gradient-aware variable that can be optimized.

Implementations§

Source §

impl Variable

Source

pub fn new<T, D>(name: &str, array: Array<T, D>) -> Self
where T: Clone + Send + Sync + 'static, D: Dimension + Send + Sync + 'static,

Create a new variable from an array.

Source

pub const fn tensor(&self) -> &GradientTensor

Get the gradient tensor.

Source

pub fn value(&self) -> Rc<dyn ArrayProtocol>

Get the value of the variable.

Source

pub fn grad_2(&self) -> Option<Rc<dyn ArrayProtocol>>

Get the gradient of the variable.

Source

pub fn name(&self) -> &str

Get the name of the variable.

Source

pub fn set_gradient( &mut self, gradient: Box<dyn ArrayProtocol>, ) -> CoreResult<()>

Set the gradient of the variable

Source

pub fn set_value(&mut self, newvalue: Box<dyn ArrayProtocol>)

Set the value of the variable (for updating during optimization).

Auto Trait Implementations§

§

impl !UnwindSafe for Variable

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §