Struct SurfaceModelConfig 

pub struct SurfaceModelConfig<T = f64> { /* private fields */ }

Hyperparameters for the multi-layer perceptron model

Implementations

impl<T> SurfaceModelConfig<T>

pub fn new(learning_rate: T, momentum: T, decay: T) -> Self

pub const fn decay(&self) -> &T

returns a reference to the decay of the model

pub const fn decay_mut(&mut self) -> &mut T

returns a mutable reference to the decay of the model

pub const fn learning_rate(&self) -> &T

returns a reference to the learning rate of the model

pub const fn learning_rate_mut(&mut self) -> &mut T

returns a mutable reference to the learning rate of the model

pub const fn momentum(&self) -> &T

returns a reference to the momentum of the model

pub const fn momentum_mut(&mut self) -> &mut T

returns a mutable reference to the momentum of the model

pub fn set_decay(&mut self, decay: T) -> &mut Self

update the decay and return a mutable reference to the config

pub fn set_learning_rate(&mut self, learning_rate: T) -> &mut Self

update the learning rate and return a mutable reference to the config

pub fn set_momentum(&mut self, momentum: T) -> &mut Self

update the momentum and return a mutable reference to the config

pub fn with_decay(self, decay: T) -> Self

consumes the current instance to create another with the given decay

pub fn with_learning_rate(self, learning_rate: T) -> Self

consumes the current instance to create another with the given learning rate

pub fn with_momentum(self, momentum: T) -> Self

consumes the current instance to create another with the given momentum

Trait Implementations

impl<T: Clone> Clone for SurfaceModelConfig<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SurfaceModelConfig<T>

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

Formats the value using the given formatter.

impl<T> Default for SurfaceModelConfig<T>

where T: FromPrimitive,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for SurfaceModelConfig<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Hash> Hash for SurfaceModelConfig<T>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for SurfaceModelConfig<T>

fn cmp(&self, other: &SurfaceModelConfig<T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for SurfaceModelConfig<T>

fn eq(&self, other: &SurfaceModelConfig<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for SurfaceModelConfig<T>

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> Serialize for SurfaceModelConfig<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy> Copy for SurfaceModelConfig<T>

impl<T: Eq> Eq for SurfaceModelConfig<T>

impl<T> StructuralPartialEq for SurfaceModelConfig<T>