Enum RestorationOutcome 

pub enum RestorationOutcome {
    Recovered,
    Failed,
    LocallyInfeasible,
    UserRequestedStop,
    FeasiblePointFound,
}

Outcome of a restoration attempt. Mirrors upstream’s bool return from RestorationPhase::PerformRestoration plus the in-band info_skip_output / iter_count side-effects that the impl writes to data directly.

Variants

Recovered

Resto succeeded; outer loop should accept_trial_point and continue. The impl has written the recovered iterate into data.trial, set info_skip_output = true, and updated the info counters.

Failed

Resto failed. Outer loop maps this to SolverReturn::RestorationFailure.

LocallyInfeasible

The inner sub-IPM converged its KKT system but the orig-NLP constraint violation at the converged point is still well above tol. Mirrors the LOCALLY_INFEASIBLE exception thrown from IpRestoConvCheck.cpp:240. Outer loop maps this to SolverReturn::LocalInfeasibility.

UserRequestedStop

The user’s intermediate callback returned false from a restoration-phase fire (gh#645). Outer loop maps this to SolverReturn::UserRequestedStop without promoting the staged trial point, so the solve hands back the last iterate accepted for the original NLP rather than a point of the restoration subproblem — the same discipline the pounce#244 deadline exit already follows.

FeasiblePointFound

The original NLP is square and the restoration phase reached a point feasible for it to constr_viol_tol. Port of the FEASIBILITY_PROBLEM_SOLVED throw at IpRestoMinC_1Nrm.cpp:269; the outer loop maps this to SolverReturn::FeasiblePointFound (IpIpoptAlg.cpp:542) after recomputing the multipliers of the feasibility problem. The impl has already promoted the recovered point to data.curr.

Trait Implementations

impl Clone for RestorationOutcome

fn clone(&self) -> RestorationOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RestorationOutcome

impl Debug for RestorationOutcome

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

Formats the value using the given formatter.

impl Eq for RestorationOutcome

impl PartialEq for RestorationOutcome

fn eq(&self, other: &RestorationOutcome) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RestorationOutcome