Skip to main content

ComplementarityInfo

Struct ComplementarityInfo 

Source
pub struct ComplementarityInfo {
    pub strategy: String,
    pub accepted_by: Option<String>,
    pub fallback: Option<String>,
    pub reported: String,
    pub summary: String,
    pub solves: Vec<ComplementaritySolveInfo>,
    pub total_iterations: usize,
    pub max_abs_product: Option<f64>,
    pub certificate: Option<ComplementarityCertificateInfo>,
    pub b_stationarity: Option<ComplementarityBStationarityInfo>,
    pub escapes: usize,
}
Expand description

The complementarity driver’s record: which formulation answered, every lowered solve it ran, and the stationarity certificate of the reported point. Keyed like Python’s info["complementarity"].

statistics.iteration_count is the iteration count of the one lowered solve whose point was reported; the driver runs several, and Self::total_iterations is what the solve cost — the same honesty rule as SecondOpinionInfo::total_iteration_count.

Fields§

§strategy: String

complementarity_strategy: both, exact or continuation.

§accepted_by: Option<String>

The formulation whose strongly stationary answer was reported, or None when no formulation answered.

§fallback: Option<String>

The formulation whose weakly stationary point was reported when no formulation answered, if that is what was reported.

§reported: String

What was reported and on what grounds: answer, weak_fallback, feasible_uncertified or verdict.

§summary: String

The driver’s one-line account, as printed on the console.

§solves: Vec<ComplementaritySolveInfo>

Every lowered solve, in order.

§total_iterations: usize

Iterations summed over every lowered solve.

§max_abs_product: Option<f64>

The reported point’s complementarity violation – the largest |G·H| over one-sided pairs, the largest positive part of a mixed pair’s products – or null when it has no point (a solve refused before iteration 0).

§certificate: Option<ComplementarityCertificateInfo>

The stationarity certificate of the reported point; None only if the model could not be evaluated there.

§b_stationarity: Option<ComplementarityBStationarityInfo>

The B-stationarity check of the reported point: run when it is feasible and not certified S (S implies B). None when it did not run. Additive; older reports without the field deserialize unchanged.

§escapes: usize

Branch NLPs that moved the reported point off a non-B-stationary one. Additive; reads 0 on reports written before the field existed.

Trait Implementations§

Source§

impl Clone for ComplementarityInfo

Source§

fn clone(&self) -> ComplementarityInfo

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 ComplementarityInfo

Source§

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

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

impl<'de> Deserialize<'de> for ComplementarityInfo

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<ComplementarityInfo, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ComplementarityInfo

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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