Enum Rate 

pub enum Rate {
    Fixed(f32),
    Linear(f32, f32, usize),
    Exponential(f32, f32, usize),
    Cyclical(f32, f32, usize, CycleShape),
    Stepwise(Vec<(usize, f32)>),
    WarmupExp {
        warmup_steps: usize,
        start: f32,
        peak: f32,
        end: f32,
        half_life: usize,
    },
}

Variants

Fixed(f32)

Linear(f32, f32, usize)

A linear rate that changes from start to end over a number of steps.

Parameters

• start: The starting rate value.
• end: The ending rate value.
• steps: The number of steps over which to change the rate.

Exponential(f32, f32, usize)

An exponential rate that changes from start to end over a half-life period.

Parameters

• start: The starting rate value.
• end: The ending rate value.
• half_life: The half-life period over which to change the rate.

Cyclical(f32, f32, usize, CycleShape)

A cyclical rate that oscillates between min and max over a period.

Parameters

• min: The minimum rate value.
• max: The maximum rate value.
• period: The period over which to cycle the rate.
• shape: The shape of the cycle (Triangle or Sine).

Stepwise(Vec<(usize, f32)>)

Piecewise-constant schedule: at each listed step, rate jumps to the given value. The value remains constant until the next listed step. The first step must be 0. If the current step is beyond the last listed step, the rate remains at the last value.

Parameters

• Vec<(usize, f32)>: A vector of (step, rate) pairs.

WarmupExp

A warmup exponential schedule that starts at start, rises to peak over warmup_steps, then decays to end with a half-life of half_life.

Parameters

• warmup_steps: Number of steps to reach peak from start.
• start: The starting rate value.
• peak: The peak rate value after warmup.
• end: The ending rate value after decay.
• half_life: The half-life period for decay after warmup.

Fields

warmup_steps: usize

start: f32

peak: f32

end: f32

half_life: usize

Implementations

impl Rate

pub fn value(&self, step: usize) -> f32

Trait Implementations

impl Clone for Rate

fn clone(&self) -> Rate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rate

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

Formats the value using the given formatter.

impl Default for Rate

fn default() -> Self

Returns the “default value” for a type.

impl From<Vec<(usize, f32)>> for Rate

fn from(steps: Vec<(usize, f32)>) -> Self

Converts to this type from the input type.

impl From<f32> for Rate

fn from(value: f32) -> Self

Converts to this type from the input type.

impl PartialEq for Rate

fn eq(&self, other: &Rate) -> 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 Valid for Rate

fn is_valid(&self) -> bool

impl StructuralPartialEq for Rate