Skip to main content

RestoOptions

Struct RestoOptions 

Source
pub struct RestoOptions {
    pub bound_mult_reset_threshold: Number,
    pub constr_mult_reset_threshold: Number,
    pub resto_penalty_parameter: Number,
    pub resto_proximity_weight: Number,
    pub required_infeasibility_reduction: Number,
    pub evaluate_orig_obj_at_resto_trial: bool,
    pub expect_infeasible_problem: bool,
    pub start_with_resto: bool,
}
Expand description

Restoration-phase knobs carried on the outer builder and copied into the RestoAlgorithmBuilder when the restoration factory is minted (pounce-restoration). The restoration builder is constructed with defaults by each frontend and never options-configured, so these were registered but never read (#191). Defaults mirror upstream’s restoration RegisterOptions.

Fields§

§bound_mult_reset_threshold: Number

bound_mult_reset_threshold — reset bound multipliers to 1 after restoration if the largest exceeds this.

§constr_mult_reset_threshold: Number

constr_mult_reset_threshold — ignore the least-square constraint multiplier estimate after restoration if its norm exceeds this (0 keeps the estimate).

§resto_penalty_parameter: Number

resto_penalty_parameter — penalty on the slack 1-norm in the restoration objective (rho).

§resto_proximity_weight: Number

resto_proximity_weight — proximity-term weight (eta_factor; η = eta_factor · sqrt(μ)).

§required_infeasibility_reduction: Number

required_infeasibility_reduction — the restoration sub-solve keeps iterating until the original NLP’s infeasibility has been reduced to at most this fraction of its value at restoration entry (κ_resto in IpRestoConvCheck.cpp:58). 0 disables the guard, i.e. restoration runs until the sub-NLP itself converges.

§evaluate_orig_obj_at_resto_trial: bool

evaluate_orig_obj_at_resto_trial — evaluate the original objective at every restoration trial point, so an iterate the restoration problem likes but the original cannot evaluate is rejected there rather than after the phase exits. Upstream default yes. RestoAlgorithmBuilder has consumed this since it landed; only the read site was missing (gh#483, #191 round 2).

§expect_infeasible_problem: bool

expect_infeasible_problem — enter restoration sooner and demand more infeasibility reduction before leaving it. Upstream default no. Same story: consumed, never read.

§start_with_resto: bool

start_with_resto — switch to restoration in the first iteration. Upstream default no. Same story.

Trait Implementations§

Source§

impl Clone for RestoOptions

Source§

fn clone(&self) -> RestoOptions

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 RestoOptions

Source§

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

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

impl Default for RestoOptions

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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