Struct IntermediateCallbackData 

pub struct IntermediateCallbackData {
    pub alg_mod: AlgorithmMode,
    pub iter_count: i32,
    pub obj_value: f64,
    pub inf_pr: f64,
    pub inf_du: f64,
    pub mu: f64,
    pub d_norm: f64,
    pub regularization_size: f64,
    pub alpha_du: f64,
    pub alpha_pr: f64,
    pub ls_trials: i32,
}

Pieces of solver data available from Ipopt after each iteration inside the intermediate callback.

Fields

alg_mod: AlgorithmMode

Algorithm mode indicates which mode the algorithm is currently in.

iter_count: i32

The current iteration count.

This includes regular iterations and iterations during the restoration phase.

obj_value: f64

The unscaled objective value at the current point.

During the restoration phase, this value remains the unscaled objective value for the original problem.

inf_pr: f64

The unscaled constraint violation at the current point.

This quantity is the infinity-norm (max) of the (unscaled) constraints. During the restoration phase, this value remains the constraint violation of the original problem at the current point. The option inf_pr_output can be used to switch to the printing of a different quantity.

inf_du: f64

The scaled dual infeasibility at the current point.

This quantity measures the infinity-norm (max) of the internal dual infeasibility, Eq. (4a) in the implementation paper, including inequality constraints reformulated using slack variables and problem scaling. During the restoration phase, this is the value of the dual infeasibility for the restoration phase problem.

mu: f64

The value of the barrier parameter $ \mu$.

d_norm: f64

The infinity norm (max) of the primal step (for the original variables $ x$ and the internal slack variables $ s$).

During the restoration phase, this value includes the values of additional variables, $ p$ and $ n$ (see Eq. (30) in the implementation paper)

regularization_size: f64

The value of the regularization term for the Hessian of the Lagrangian in the augmented system

This is $ \delta_w$ in Eq. (26) and Section 3.1 in the implementation paper. A zero value indicates that no regularization was done.

alpha_du: f64

The stepsize for the dual variables.

This is $ \alpha^z_k$ in Eq. (14c) in the implementation paper.

alpha_pr: f64

The stepsize for the primal variables.

This is $ \alpha_k$ in Eq. (14a) in the implementation paper.

ls_trials: i32

The number of backtracking line search steps (does not include second-order correction steps).

Trait Implementations

impl Clone for IntermediateCallbackData

fn clone(&self) -> IntermediateCallbackData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IntermediateCallbackData

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

Formats the value using the given formatter.

impl PartialEq for IntermediateCallbackData

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for IntermediateCallbackData

impl StructuralPartialEq for IntermediateCallbackData