Skip to main content

PdPerturbationHandler

pounce_algorithm::kkt::perturbation_handler

Struct PdPerturbationHandler 

Source 
pub struct PdPerturbationHandler {
Show 27 fields
    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,

}
Expand description

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.

Implementations§

Source§

impl PdPerturbationHandler

Source

pub fn new() -> PdPerturbationHandler

Source

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

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

Source

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).

Source

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).

Source

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).

Source

pub fn current_perturbation(&self) -> Deltas

Read the most recently committed perturbations.

Trait Implementations§

Source§

impl Clone for PdPerturbationHandler

Source§

fn clone(&self) -> PdPerturbationHandler

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PdPerturbationHandler

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PdPerturbationHandler

Source§

fn default() -> PdPerturbationHandler

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more