Enum DampingSchedule 

pub enum DampingSchedule {
    Fixed(f64),
    Linear {
        start: f64,
        end: f64,
        total_steps: usize,
    },
    Exponential {
        initial: f64,
        decay: f64,
    },
    Adaptive {
        base: f64,
        increase_rate: f64,
        decrease_rate: f64,
    },
}

Damping schedule types for controlling how damping evolves over iterations.

Variants

Fixed(f64)

Fixed damping throughout all iterations.

Linear

Linear interpolation from start to end over total_steps.

Fields

start: f64

Starting damping value.

end: f64

Ending damping value.

total_steps: usize

Total steps over which to interpolate.

Exponential

Exponential decay: initial * decay^iteration.

Fields

initial: f64

Initial damping value.

decay: f64

Decay rate per iteration.

Adaptive

Increase damping when residual grows, decrease when stable.

Fields

base: f64

Minimum damping floor.

increase_rate: f64

Rate at which damping increases on divergence.

decrease_rate: f64

Rate at which damping decreases on convergence.

Implementations

impl DampingSchedule

pub fn get_damping( &self, iteration: usize, prev_residual: Option<f64>, curr_residual: Option<f64>, current_damping: f64, ) -> f64

Get damping factor for a given iteration and optional residual information.

Arguments

• iteration - Current iteration number
• prev_residual - Residual from the previous iteration (if available)
• curr_residual - Residual from the current iteration (if available)
• current_damping - The current damping factor (used by adaptive schedule)

Trait Implementations

impl Clone for DampingSchedule

fn clone(&self) -> DampingSchedule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DampingSchedule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DampingSchedule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DampingSchedule

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

where __S: Serializer,

Serialize this value into the given Serde serializer.