Skip to main content

CrossoverReport

Struct CrossoverReport 

Source
pub struct CrossoverReport {
    pub phase: Option<CrossoverPhase>,
    pub declined: Option<CrossoverDecline>,
    pub n_iter: u32,
    pub n_qp_solves: u32,
    pub active_bounds: usize,
    pub active_constraints: usize,
    pub estimated_active: usize,
    pub kkt_before: Number,
    pub kkt_after: Number,
    pub compl_after: Number,
}
Expand description

What crossover did. Retrieved from crate::application::IpoptApplication::crossover_report.

Fields§

§phase: Option<CrossoverPhase>

The phase that produced the accepted point; None when crossover declined.

§declined: Option<CrossoverDecline>

Why it declined; None when it did not.

§n_iter: u32

Outer iterations spent in the step-4 fallback. 0 on the step-3 path.

§n_qp_solves: u32

QP subproblems solved across both phases, step 3’s included.

§active_bounds: usize

Variable bounds in the identified active set (AtLower, AtUpper or Fixed), read off the returned point where the primal test is exact. See [identify_at].

§active_constraints: usize

Constraint rows in the identified active set (equalities included — they are unconditionally active).

§estimated_active: usize

Rows and bounds the §7 step-2 tolerance test called active at the interior iterate, before any pivoting.

Compare against active_bounds + active_constraints, which is the same question answered at the crossed-over point. They differ exactly where the interior iterate could not support the inference — the measurement this phase exists to make.

§kkt_before: Number

max(stationarity, constraint violation) at the interior iterate.

§kkt_after: Number

The same at the returned point. Never worse than kkt_before beyond the tolerances accepts allows.

§compl_after: Number

Max-norm complementarity at the returned point, measured against the declared bounds — see [complementarity_at]. NaN when crossover declined.

This exists because the interior method’s own complementarity is measured against the relaxed bounds, and after crossover the two frames disagree by the entire relaxation: an iterate sitting exactly on a declared bound is bound_relax_factor inside the relaxed one, so the relaxed reading is |multiplier| · δ — around 1e-8 — where the truth is zero. Reporting that as the solve’s complementarity printed a converged run as Overall NLP error above tol (#646). The caller substitutes this figure when the point was accepted.

Implementations§

Source§

impl CrossoverReport

Source

pub fn accepted(&self) -> bool

Did crossover replace the interior iterate?

Trait Implementations§

Source§

impl Clone for CrossoverReport

Source§

fn clone(&self) -> CrossoverReport

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 CrossoverReport

Source§

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

Formats the value using the given formatter. 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