Struct optimization_engine::alm::AlmOptimizerStatus

pub struct AlmOptimizerStatus { /* private fields */ }

Solution statistics for AlmOptimizer

This structure has no public fields and no public setter methods.
The idea is that only Optimization Engine can create optimizer AlmOptimizerStatus instances.

Implementations

impl AlmOptimizerStatus

pub fn update_cost(&mut self, new_cost: f64)

Update cost (to be used when the cost needs to be scaled as a result of preconditioning)

pub fn update_f1_infeasibility(&mut self, new_alm_infeasibility: f64)

Update ALM infeasibility

pub fn update_f2_norm(&mut self, new_pm_infeasibility: f64)

Update PM infeasibility

pub fn exit_status(&self) -> ExitStatus

Exit status of solver

Panics

Does not panic

pub fn num_outer_iterations(&self) -> usize

Number of outer iterations

Panics

Does not panic

pub fn num_inner_iterations(&self) -> usize

Total count of inner iterations performed by PANOCOptimizer

Panics

Does not panic

pub fn lagrange_multipliers(&self) -> &Option<Vec<f64>>

Vector of Lagrange multipliers at the solution

The method returns a reference to an Option<Vec<f64>> which contains the vector of Lagrange multipliers at the solution, or is None if the problem has no ALM-type constraints.

Panics

Does not panic

pub fn last_problem_norm_fpr(&self) -> f64

Norm of the fixed-point residual of the last inner problem

Panics

Does not panic

pub fn solve_time(&self) -> Duration

Total time to solve the problem (runtime of method AlmOptimizer.solve())

Panics

Does not panic

pub fn penalty(&self) -> f64

Penalty parameter at the solution

Panics

Does not panic

pub fn delta_y_norm_over_c(&self) -> f64

Norm of Delta y divided by max{c, 1} - measure of infeasibility

pub fn f2_norm(&self) -> f64

Norm of F2(u) - measure of infeasibility of F2(u) = 0

pub fn cost(&self) -> f64

Value of the cost function at the solution

Trait Implementations

impl Debug for AlmOptimizerStatus

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

Formats the value using the given formatter.