Enum Decay 

pub enum Decay {
    None(f32),
    Linear {
        start: f32,
        decay: f32,
    },
    Cosine {
        start: f32,
        end: f32,
        num_steps: usize,
    },
}

A value which can decay according to some schedule over the progression of timesteps.

Variants

None(f32)

No decay: The specified constant is used regardless of timestep.

Linear

Linear decay: The value decays from start by decay each timestep.

Fields

start: f32

decay: f32

Cosine

Cosine decay: The value smoothly decays from start to end over num_steps timesteps, with the decay matching the shape of the cosine function.

Fields

start: f32

end: f32

num_steps: usize

Implementations

impl Decay

pub fn start_value(&self) -> f32

The output value at timestep 0.

pub fn at_timestep(&self, timestep: usize) -> f32

The output value at the specified timestep.

Trait Implementations

impl Clone for Decay

fn clone(&self) -> Decay

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Decay

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Decay

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Decay

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

where __S: Serializer,

Serialize this value into the given Serde serializer.