Struct Param

pub struct Param<T> {
    pub value: T,
    /* private fields */
}

A simple wrapper for a module parameter.

Fields

value: T

The value of the parameter.

Implementations

impl<T> Param<T>

pub fn new(value: T) -> Self

Create a new Param

Trait Implementations

impl<T> AsMut<T> for Param<T>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<T> for Param<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for Param<T>

fn clone(&self) -> Param<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Param<T>

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

Formats the value using the given formatter.

impl<T> Deref for Param<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Param<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> From<T> for Param<T>

fn from(inner: T) -> Self

Converts to this type from the input type.

impl Parameter for Param<Array>

fn freeze(&mut self, _recursive: bool)

Freeze the parameter.

fn unfreeze(&mut self, _recursive: bool)

Unfreeze the parameter.

fn is_frozen(&self) -> Option<bool>

Check if the parameter is frozen. Returns None if the parameter is a module that has no parameters.

fn as_nested_value<'a>(&self) -> NestedValue<Rc<str>, &Array>

Get the parameter as a nested value.

fn as_nested_value_mut<'a>(&mut self) -> NestedValue<Rc<str>, &mut Array>

Get the parameter as a mutable nested value.

fn as_trainable_nested_value<'a>(&self) -> Option<NestedValue<Rc<str>, &Array>>

Get the parameter as a nested value if it is trainable.

impl Parameter for Param<Option<Array>>

fn freeze(&mut self, _recursive: bool)

Freeze the parameter.

fn unfreeze(&mut self, _recursive: bool)

Unfreeze the parameter.

fn is_frozen(&self) -> Option<bool>

Check if the parameter is frozen. Returns None if the parameter is a module that has no parameters.

fn as_nested_value(&self) -> NestedValue<Rc<str>, &Array>

Get the parameter as a nested value.

fn as_nested_value_mut(&mut self) -> NestedValue<Rc<str>, &mut Array>

Get the parameter as a mutable nested value.

fn as_trainable_nested_value(&self) -> Option<NestedValue<Rc<str>, &Array>>

Get the parameter as a nested value if it is trainable.