Skip to main content

Solution

Struct Solution 

Source
pub struct Solution {
    pub status: SolveStatus,
    pub x: Vec<f64>,
    pub dual: DualVariables,
    pub objective: f64,
    pub residuals: KktResiduals,
    pub iterations: usize,
    pub solve_time: Duration,
    pub final_rho: f64,
    pub rho_updates: usize,
    pub polished: bool,
    pub diagnostics: Option<ConvergenceDiagnostics>,
    pub certificate: Option<Certificate>,
}
Expand description

Solver result and diagnostics.

Fields§

§status: SolveStatus

Termination status.

§x: Vec<f64>

Primal decision vector.

§dual: DualVariables

Constraint multipliers.

§objective: f64

Objective value at the returned iterate.

§residuals: KktResiduals

KKT residuals at the returned iterate.

§iterations: usize

Number of completed ADMM iterations.

§solve_time: Duration

Wall-clock time this solve was charged with: setup plus iteration for Solver::solve, iteration only for Workspace::solve (setup was paid at workspace construction).

§final_rho: f64

Penalty used for the final iteration.

§rho_updates: usize

Number of adaptive penalty changes. Each change needs the matching reduced factorization: one-shot solves rebuild it, workspace solves reuse a cached one when the penalty was already visited.

§polished: bool

Whether the returned iterate is the polished one: true only when the status is SolveStatus::Solved, SolverSettings::polish is enabled, and the direct active-set solve improved the worst KKT residual (otherwise the ADMM iterate is kept and this stays false).

§diagnostics: Option<ConvergenceDiagnostics>

Heuristic hints; present only when the status is not Solved.

§certificate: Option<Certificate>

Infeasibility proof; present only when the status is SolveStatus::PrimalInfeasible or SolveStatus::DualInfeasible.

Certificates are normalized to unit infinity norm, reported in the original data space, and independently auditable with crate::check_primal_certificate / crate::check_dual_certificate.

Implementations§

Source§

impl Solution

Source

pub fn warm_start(&self) -> WarmStart

Converts this solution into a full warm start for a related solve.

Trait Implementations§

Source§

impl Clone for Solution

Source§

fn clone(&self) -> Solution

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 Solution

Source§

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

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

impl PartialEq for Solution

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Solution

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> 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> 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> 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.