Struct optimization_engine::core::solver_status::SolverStatus

pub struct SolverStatus { /* fields omitted */ }

Solver status

This structure contais information about the solver status. Instances of SolverStatus are returned by optimizers.

Methods

impl SolverStatus

pub fn new(
    exit_status: ExitStatus,
    num_iter: usize,
    solve_time: Duration,
    fpr_norm: f64,
    cost_value: f64
) -> SolverStatus

Constructs a new instance of SolverStatus

Arguments

• converged whether the algorithm has converged to a solution up to the specified tolerance
• num_iter number of iterations
• fpr_norm norm of the fixed-point residual; a gauge of the solution quality
• cost_value the value of the cost function at the solution

pub fn has_converged(&self) -> bool

whether the algorithm has converged

pub fn iterations(&self) -> usize

number of iterations taken by the algorithm

pub fn solve_time(&self) -> Duration

total execution time

pub fn norm_fpr(&self) -> f64

norm of the fixed point residual

pub fn cost_value(&self) -> f64

value of the cost at the solution

pub fn exit_status(&self) -> ExitStatus

exit status of solver

Trait Implementations

impl PartialEq<SolverStatus> for SolverStatus

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for SolverStatus

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

Formats the value using the given formatter.