scirs2_optimize::differentiable_optimization::types

Struct KKTSystem

pub struct KKTSystem {
    pub stationarity: Vec<f64>,
    pub primal_eq: Vec<f64>,
    pub primal_ineq: Vec<f64>,
    pub complementarity: Vec<f64>,
    pub max_residual: f64,
}

Expand description

KKT system residuals for monitoring convergence.

Fields§

§stationarity: Vec<f64>

Stationarity residual: Qx + c + G’λ + A’ν.

§primal_eq: Vec<f64>

Primal feasibility (equality): Ax - b.

§primal_ineq: Vec<f64>

Primal feasibility (inequality): Gx - h (should be ≤ 0).

§complementarity: Vec<f64>

Complementary slackness: λ_i * (Gx - h)_i.

§max_residual: f64

Maximum absolute residual across all conditions.

Implementations§

Source §

impl KKTSystem

Source

pub fn is_satisfied(&self, tol: f64) -> bool

Check whether all KKT residuals are below the given tolerance.

Trait Implementations§

Source §

impl Clone for KKTSystem

Source §

fn clone(&self) -> KKTSystem

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for KKTSystem

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for KKTSystem

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> 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> Into 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 §