Skip to main content

ModelResult

Struct ModelResult 

Source
pub struct ModelResult {
    pub status: SolveStatus,
    pub proof: SolutionProof,
    pub objective_value: f64,
    pub dual_solution: Option<Vec<f64>>,
    pub reduced_costs: Option<Vec<f64>>,
    pub slack: Option<Vec<f64>>,
    pub bound_duals: Vec<f64>,
    pub stats: SolveStats,
    /* private fields */
}
Expand description

The result of a successful solve.

Fields§

§status: SolveStatus

Solver termination status associated with this returned solution.

Only success-domain variants occur here (Optimal, LocallyOptimal, NonconvexLocal, NonconvexGlobal, MaxIterations, SuboptimalSolution, Timeout); error variants surface as ModelError instead. Match on ModelResult::proof for the optimality guarantee.

§proof: SolutionProof

Optimality proof quality for this returned solution.

§objective_value: f64

Optimal objective value.

§dual_solution: Option<Vec<f64>>

Dual solution (shadow prices), if available.

§reduced_costs: Option<Vec<f64>>

Reduced costs, if available.

通常は c − A^T y。例外: presolve の bound-tightened-fixed 列が 元の 上下限に 着地した場合、reduced_costs[j] には bound dual (μ_lb / μ_ub) が暗黙吸収され、 raw c − A^T y ではなく at-lb で max(·, 0) / at-ub で min(·, 0) の clamp 値 となる (presolve/postsolve.rs::BoundAbsorb)。LP path で bound_duals は default 空のため μ を分離取得することはできない (QP path のみ populate)。

§slack: Option<Vec<f64>>

Constraint slacks, if available.

§bound_duals: Vec<f64>

Variable bound dual values (QP path). Layout: [lb_dual for each var with finite lb, ub_dual for each var with finite ub] Empty when not provided by the solver.

§stats: SolveStats

Per-solve routing and warm-start statistics (race-free, per-result).

Implementations§

Source§

impl ModelResult

Source

pub fn value(&self, var: Variable) -> f64

Get the primal value of a variable.

§Panics

Panics if the variable index is out of range. Use try_value to handle this case gracefully.

Source

pub fn try_value(&self, var: Variable) -> Result<f64, ModelError>

Get the primal value of a variable, returning an error instead of panicking.

Returns Err if:

  • var was created by a different model than the one that produced this result.
  • var.index is out of range for the solution vector.
Source

pub fn objective(&self) -> f64

Get the optimal objective value.

Source

pub fn has_global_optimality_proof(&self) -> bool

Returns true when the solver proved global optimality for this result.

Trait Implementations§

Source§

impl Clone for ModelResult

Source§

fn clone(&self) -> ModelResult

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 ModelResult

Source§

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

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

impl Index<Variable> for ModelResult

Index a ModelResult by Variable to get the primal solution value.

§Example

println!("x = {}", result[x]);
Source§

type Output = f64

The returned type after indexing.
Source§

fn index(&self, var: Variable) -> &f64

Performs the indexing (container[index]) operation. 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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

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

Source§

fn vzip(self) -> V