Skip to main content

WarmStartDiagnostics

Struct WarmStartDiagnostics 

Source
pub struct WarmStartDiagnostics {
    pub primal_residual: Number,
    pub dual_residual: Number,
    pub complementarity: Number,
    pub mu_in: Number,
    pub mu_out: Number,
    pub bound_duals: BlockVerdict,
    pub eq_duals: BlockVerdict,
    pub bound_duals_reconstructed: usize,
    pub bound_duals_rejected: usize,
    pub eq_duals_rejected: bool,
    pub stationarity_split: bool,
    pub recentering_disabled: bool,
}
Expand description

What the warm-start initializer accepted, reconstructed, or discarded, and the residuals it based those calls on (gh#606).

Written once per solve, at initialization. mu_in is what mu_init / warm_start_target_mu asked for; mu_out is what the iterate actually starts at.

Fields§

§primal_residual: Number

‖c(x)‖_∞ of the supplied primal point, measured before any dual reconstruction (it does not depend on the duals).

§dual_residual: Number

‖∇_x L‖_∞ after reconstruction.

§complementarity: Number

Average complementarity after reconstruction.

§mu_in: Number§mu_out: Number§bound_duals: BlockVerdict§eq_duals: BlockVerdict§bound_duals_reconstructed: usize

Bound-multiplier entries that arrived unseeded and were filled from μ̂ / slack rather than from the constant floor.

§bound_duals_rejected: usize

Bound-multiplier entries that arrived seeded and were refused as incoherent with the primal point, taking the pre-gh#606 constant fill instead (gh#617).

§eq_duals_rejected: bool

true when the seeded equality multipliers were refused as incoherent with the primal point, so the stationarity split was not run off them (gh#617). The y block itself is left where the caller put it — that is what the pre-gh#606 path does with a supplied y — but it stops being an input to anything.

§stationarity_split: bool

true when the unseeded bound multipliers were re-derived from the stationarity identity rather than left at μ̂ / slack. That needs a caller-supplied y; see [refine_bound_duals_from_stationarity].

§recentering_disabled: bool

true when warm_start_recentering=none turned all of the above off and the fields are the legacy constants.

Trait Implementations§

Source§

impl Clone for WarmStartDiagnostics

Source§

fn clone(&self) -> WarmStartDiagnostics

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 WarmStartDiagnostics

Source§

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

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

impl Default for WarmStartDiagnostics

Source§

fn default() -> Self

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