Struct PdPerturbationHandler 

pub struct PdPerturbationHandler {

    pub delta_xs_max: f64,
    pub delta_xs_min: f64,
    pub delta_xs_first_inc_fact: f64,
    pub delta_xs_inc_fact: f64,
    pub delta_xs_dec_fact: f64,
    pub delta_xs_init: f64,
    pub delta_cd_val: f64,
    pub delta_cd_exp: f64,
    pub perturb_always_cd: bool,
    pub reset_last: bool,
    pub degen_iters_max: i32,
    pub delta_x_curr: f64,
    pub delta_s_curr: f64,
    pub delta_c_curr: f64,
    pub delta_d_curr: f64,
    pub delta_x_last: f64,
    pub delta_s_last: f64,
    pub delta_c_last: f64,
    pub delta_d_last: f64,
    pub get_deltas_for_wrong_inertia_called: bool,
    pub hess_degenerate: DegenType,
    pub jac_degenerate: DegenType,
    pub degen_iters: i32,
    pub test_status: TrialStatus,
    pub delta_c_rungs: i32,
    pub delta_c_abandoned: bool,
    pub delta_c_max_rungs: i32,
    pub delta_x_at_withdrawal: f64,
    pub delta_c_reinstated: bool,
    pub withdrawal_untested: bool,
}

State + algorithmic parameters. Defaults mirror IpPDPerturbationHandler.cpp::RegisterOptions.

Fields

delta_xs_max: f64

delta_xs_min: f64

delta_xs_first_inc_fact: f64

delta_xs_inc_fact: f64

delta_xs_dec_fact: f64

delta_xs_init: f64

delta_cd_val: f64

delta_cd_exp: f64

perturb_always_cd: bool

reset_last: bool

degen_iters_max: i32

delta_x_curr: f64

delta_s_curr: f64

delta_c_curr: f64

delta_d_curr: f64

delta_x_last: f64

delta_s_last: f64

delta_c_last: f64

delta_d_last: f64

get_deltas_for_wrong_inertia_called: bool

hess_degenerate: DegenType

jac_degenerate: DegenType

degen_iters: i32

test_status: TrialStatus

delta_c_rungs: i32

gh#592: how many rungs of the δ_x ladder have been taken for the current aug-system while δ_c > 0. Reset by Self::consider_new_system.

delta_c_abandoned: bool

gh#592: δ_c has already been withdrawn once for this aug-system, so it must not be raised again before the next Self::consider_new_system. Without the latch a linear solver that keeps reporting Singular for the same reason would put it straight back and the walk-back would cycle.

delta_c_max_rungs: i32

gh#592: the rung at which δ_c is withdrawn — see Self::perturb_for_wrong_inertia. 0 disables the walk-back and restores the pre-#592 escalation exactly.

delta_x_at_withdrawal: f64

gh#981: the δ_x rung at which δ_c was withdrawn. The factor at (δ_x, δ_c) reported WrongInertia, i.e. was nonsingular; a certified Singular without δ_c refutes the withdrawal and the ladder resumes from here.

delta_c_reinstated: bool

gh#981: δ_c was withdrawn and then reinstated for this aug-system. Latched so that the walk-back does not fire a second time; one withdrawal and one reinstatement per aug-system at most.

withdrawal_untested: bool

gh#981: δ_c has been withdrawn and no factorization without it has reported back yet. Only the first δ_c-free factor can refute the withdrawal: a dependent row shows up as a zero pivot at the very first rung, every time, whereas a zero pivot that appears at one rung of a long δ_x climb and not at its neighbours is round-off (measured on pooling_rt2stp, where honouring the later ones moved the exact leg to a different local optimum).

Implementations

impl PdPerturbationHandler

pub fn new() -> PdPerturbationHandler

pub fn set_perturb_always_cd(&mut self, on: bool)

Configure perturb_always_cd_ and rebuild the initial jac state. Mirrors upstream’s InitializeImpl.

pub fn consider_new_system( &mut self, mu: f64, ip_data: Option<&dyn PerturbationSink>, ) -> Option<Deltas>

First call when starting a new aug-system. mu is the current barrier parameter (used by the δ_cd formula). Returns None if no suitable starting perturbation could be found (the caller bails).

pub fn perturb_for_singular( &mut self, mu: f64, ip_data: Option<&dyn PerturbationSink>, ) -> Option<Deltas>

Escalation after Singular factorization status. Mirrors PerturbForSingularity (cpp:245-364).

pub fn perturb_for_singular_with( &mut self, mu: f64, certified: bool, ip_data: Option<&dyn PerturbationSink>, ) -> Option<Deltas>

Self::perturb_for_singular with the linear solver’s verdict on the report attached (gh#981). certified is true when the factorization found a zero pivot — a rank deficiency it measured — and false when Singular stands in for an inertia count the solver declined to trust (gh#540). The two differ only after a gh#592 walk-back: a certified Singular from the δ_c-free factor refutes the withdrawal, because the factor at that δ_x with δ_c was nonsingular and only δ_c changed, so the singularity is in the constraint block and no δ_x can remove it. δ_c is then put back and the ladder resumes from the withdrawal rung. An uncertified Singular is answered on the δ_x ladder as before — on gh#884’s biactive MPCC every post-withdrawal Singular is of that kind, and reinstating δ_c there costs the certificate.

pub fn perturb_for_wrong_inertia( &mut self, mu: f64, ip_data: Option<&dyn PerturbationSink>, ) -> Option<Deltas>

Escalation after WrongInertia factorization status. Mirrors PerturbForWrongInertia (cpp:419-450).

pub fn current_perturbation(&self) -> Deltas

Read the most recently committed perturbations.

Trait Implementations

impl Clone for PdPerturbationHandler

fn clone(&self) -> PdPerturbationHandler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PdPerturbationHandler

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

Formats the value using the given formatter.

impl Default for PdPerturbationHandler

fn default() -> PdPerturbationHandler

Returns the “default value” for a type.