Skip to content

Results and statistics

Solution

Bases: NamedTuple

The result of solving a problem.

The multipliers are those of the problem Ipopt solves, which minimizes the objective, so a problem that maximizes has the multipliers of its negated objective.

x instance-attribute

x: PyTree[ndarray]

The final point in the structure of the variables.

objective instance-attribute

objective: float

The objective at x, in the sense of the problem.

constraints instance-attribute

constraints: tuple[ndarray, ...]

The value of each constraint at x, in its own shape.

lower_multipliers instance-attribute

lower_multipliers: PyTree[ndarray]

Multipliers of the lower bounds of the variables, in the structure of x.

upper_multipliers instance-attribute

upper_multipliers: PyTree[ndarray]

Multipliers of the upper bounds of the variables, in the structure of x.

statistics instance-attribute

statistics: SolveStatistics

Counters of the callbacks that Ipopt made during the solve.

build instance-attribute

build: BuildStatistics

Time and counts of compiling the problem, zero if it was compiled before.

Status

Bases: IntEnum

Why Ipopt stopped, with the values of its ApplicationReturnStatus.

succeeded property

succeeded: bool

Whether Ipopt found a point that satisfies the tolerances or the acceptable ones.

IterationInfo

Bases: NamedTuple

What Ipopt reports at the end of an iteration, passed to the callback of a solve.

restoration instance-attribute

restoration: bool

Whether Ipopt is in its restoration phase.

step_norm instance-attribute

step_norm: float

Infinity norm of the primal step.

regularization_size instance-attribute

regularization_size: float

Size of the regularization of the Hessian of the Lagrangian.

x instance-attribute

x: PyTree[ndarray]

The current iterate in the structure of the variables.

SolveStatistics

Bases: NamedTuple

Counters of every callback of Ipopt for one solve.

CallbackStatistics

Bases: NamedTuple

Counters of one callback of Ipopt.

calls instance-attribute

calls: int

Times Ipopt called the callback.

seconds instance-attribute

seconds: float

Seconds spent executing the program of the callback.

Program

Bases: IntEnum

The programs that Ipopt's callbacks execute, in the order the native layer indexes them.

BuildStatistics

Bases: NamedTuple

Time and counts of building the programs of a problem.

detect_seconds class-attribute instance-attribute

detect_seconds: float = 0.0

Seconds spent detecting and coloring sparsity patterns.

lower_seconds class-attribute instance-attribute

lower_seconds: float = 0.0

Seconds spent tracing and lowering programs to StableHLO.

compile_seconds class-attribute instance-attribute

compile_seconds: float = 0.0

Seconds spent compiling StableHLO with the PJRT plugin.

load_seconds class-attribute instance-attribute

load_seconds: float = 0.0

Seconds spent reading lowered programs and executables from the disk cache.

lowered class-attribute instance-attribute

lowered: int = 0

Programs that were lowered.

compiled class-attribute instance-attribute

compiled: int = 0

Programs that were compiled.

loaded class-attribute instance-attribute

loaded: int = 0

Programs whose executables came from the disk cache.

wall_seconds class-attribute instance-attribute

wall_seconds: float = 0.0

Seconds the build took on the wall clock.