This pages describes the standard Ipopt console output with the default setting for option print_level.
The output is designed to provide a quick summary of each iteration as Ipopt solves the problem.
Before Ipopt starts to solve the problem, it displays the problem statistics (number of nonzero-elements in the matrices, number of variables, etc.). Note that if you have fixed variables (both upper and lower bounds are equal), Ipopt may remove these variables from the problem internally and not include them in the problem statistics.
Following the problem statistics, Ipopt will begin to solve the problem and you will see output resembling the following,
iter objective inf_pr inf_du lg(mu) ||d|| lg(rg) alpha_du alpha_pr ls 0 1.6109693e+01 1.12e+01 5.28e-01 0.0 0.00e+00 - 0.00e+00 0.00e+00 0 1 1.8029749e+01 9.90e-01 6.62e+01 0.1 2.05e+00 - 2.14e-01 1.00e+00f 1 2 1.8719906e+01 1.25e-02 9.04e+00 -2.2 5.94e-02 2.0 8.04e-01 1.00e+00h 1
and the columns of output are defined as,
Tag | Description |
---|---|
f | f-type iteration in the filter method w/o second order correction |
F | f-type iteration in the filter method w/ second order correction |
h | h-type iteration in the filter method w/o second order correction |
H | h-type iteration in the filter method w/ second order correction |
k | penalty value unchanged in merit function method w/o second order correction |
K | penalty value unchanged in merit function method w/ second order correction |
n | penalty value updated in merit function method w/o second order correction |
N | penalty value updated in merit function method w/ second order correction |
R | Restoration phase just started |
w | in watchdog procedure |
s | step accepted in soft restoration phase |
t/T | tiny step accepted without line search |
r | some previous iterate restored |
Note that the step acceptance mechanisms in Ipopt consider the barrier objective function (Eq (3a) in [12]) which is usually different from the value reported in the objective
column. Similarly, for the purposes of the step acceptance, the constraint violation is measured for the internal problem formulation, which includes slack variables for inequality constraints and potentially scaling of the constraint functions. This value, too, is usually different from the value reported in inf_pr
. As a consequence, a new iterate might have worse values both for the objective function and the constraint violation as reported in the iteration output, seemingly contradicting globalization procedure.
When the algorithm terminates, Ipopt will output a message to the screen based on the return status of the call to Optimize. The following is a list of the possible return codes, their corresponding output message to the console, and a brief description.
Solve_Succeeded
:
Console Message: EXIT: Optimal Solution Found.
This message indicates that Ipopt found a (locally) optimal point within the desired tolerances.
Solved_To_Acceptable_Level
:
Console Message: EXIT: Solved To Acceptable Level.
This indicates that the algorithm did not converge to the "desired" tolerances, but that it was able to obtain a point satisfying the "acceptable" tolerance level as specified by the acceptable_tol options. This may happen if the desired tolerances are too small for the current problem.
Feasible_Point_Found
:
Console Message: EXIT: Feasible point for square problem found.
This message is printed if the problem is "square" (i.e., it has as many equality constraints as free variables) and Ipopt found a point that is feasible w.r.t. constr_viol_tol. It may, however, not be feasible w.r.t. tol.
Infeasible_Problem_Detected
:
Console Message: EXIT: Converged to a point of local infeasibility. Problem may be infeasible.
The restoration phase converged to a point that is a minimizer for the constraint violation (in the \(\ell_1\)-norm), but is not feasible for the original problem. This indicates that the problem may be infeasible (or at least that the algorithm is stuck at a locally infeasible point). The returned point (the minimizer of the constraint violation) might help you to find which constraint is causing the problem. If you believe that the NLP is feasible, it might help to start the optimization from a different point.
Search_Direction_Becomes_Too_Small
:
Console Message: EXIT: Search Direction is becoming Too Small.
This indicates that Ipopt is calculating very small step sizes and is making very little progress. This could happen if the problem has been solved to the best numerical accuracy possible given the current scaling.
Diverging_Iterates
:
Console Message: EXIT: Iterates divering; problem might be unbounded.
This message is printed if the max-norm of the iterates becomes larger than the value of the option diverging_iterates_tol. This can happen if the problem is unbounded below and the iterates are diverging.
User_Requested_Stop
:
Console Message: EXIT: Stopping optimization at current point as requested by user.
This message is printed if the user call-back method Ipopt::TNLP::intermediate_callback returned false.
Maximum_Iterations_Exceeded
:
Console Message: EXIT: Maximum Number of Iterations Exceeded.
This indicates that Ipopt has exceeded the maximum number of iterations as specified by the option max_iter.
Maximum_WallTime_Exceeded
:
Console Message: EXIT: Maximum wallclock time exceeded.
This indicates that Ipopt has exceeded the maximum number of wallclock seconds as specified by the option max_wall_time.
Maximum_CpuTime_Exceeded
:
Console Message: EXIT: Maximum CPU time exceeded.
This indicates that Ipopt has exceeded the maximum number of CPU seconds as specified by the option max_cpu_time.
Restoration_Failed
:
Console Message: EXIT: Restoration Failed!
This indicates that the restoration phase failed to find a feasible point that was acceptable to the filter line search for the original problem. This could happen if the problem is highly degenerate, does not satisfy the constraint qualification, or if your NLP code provides incorrect derivative information.
Error_In_Step_Computation
:
Console Output: EXIT: Error in step computation!
This message is printed if Ipopt is unable to compute a step towards a new iterate and the current iterate is not acceptable for the specified tolerances.
A possible reason is that a search direction could not be computed despite several attempts to modify the iteration matrix. Usually, the value of the regularization parameter then becomes too large. One situation where this can happen is when values in the Hessian are invalid (NaN or Inf). You can check whether this is true by using the option check_derivatives_for_naninf.
Another reason is that the feasibility restoration phase could not be activated because the current iterate is not infeasible. Reasons for this again include that the problem is highly degenerate, badly scaled, does not satisfy the constraint qualification, or that your NLP code provides incorrect derivative information. Before Ipopt 3.14, this resulted in a Restoration_Failed status code with message "Restoration phase is called at almost feasible point..."
Invalid_Option
:
Console Message: (details about the particular error will be output to the console)
This indicates that there was some problem specifying the options. See the specific message for details. This return code is also used when a linear solver is choosen that was not linked in and a library that contains this linear solver could not be loaded.
Not_Enough_Degrees_Of_Freedom
:
Console Message: EXIT: Problem has too few degrees of freedom.
This indicates that your problem, as specified, has too few degrees of freedom. This can happen if you have too many equality constraints, or if you fix too many variables (Ipopt removes fixed variables by default, see also the option fixed_variable_treatment).
Invalid_Problem_Definition
:
Console Message: EXIT: Problem has inconsistent variable bounds or constraint sides.
This indicates that either there was an exception of some sort when building the IpoptProblem structure in the C or Fortran interface or bounds specified for variables or constraints were inconsistent (lower bound larger than upper bound, left-hand-side larger than right-hand-side). Likely there is an error in your model or the main routine.
Unrecoverable_Exception
:
Console Message: (details about the particular error will be output to the console)
This indicates that Ipopt has thrown an exception that does not have an internal return code. See the specific message for details.
NonIpopt_Exception_Thrown
:
Console Message: Unknown Exception caught in Ipopt
An unknown exception was caught in Ipopt. This exception could have originated from your model or any linked in third party code. See also Ipopt::IpoptApplication::RethrowNonIpoptException.
Insufficient_Memory
:
Console Message: EXIT: Not enough memory
.
An error occurred while trying to allocate memory. The problem may be too large for your current memory and swap configuration.
Console Message: EXIT: Integer type too small for required memory
.
A linear solver requires more working space than what can be communicated to it via the used integer type.
Internal_Error
:
Console: EXIT: INTERNAL ERROR: Unknown SolverReturn value - Notify IPOPT Authors.
An unknown internal error has occurred. Please notify the authors of Ipopt via the mailing list.
To print additional diagnostic tags for each iteration of Ipopt, set the option print_info_string to yes
. With this, a tag will appear at the end of an iteration line with the following diagnostic meaning that are useful to flag difficulties for a particular Ipopt run.
Tag | Description | Reference |
---|---|---|
! | Tighten resto tolerance if only slightly infeasible | Section 3.3 in [12] |
A | Current iteration is acceptable | Alternate termination |
a | Perturbation for PD singularity impossible, assume singular | Section 3.1 in [12] |
C | Second Order Correction taken | Section 2.4 in [12] |
Dh | Hessian degenerate based on multiple iterations | Section 3.1 in [12] |
Dhj | Hessian/Jacobian degenerate based on multiple iterations | Section 3.1 in [12] |
Dj | Jacobian degenerate based on multiple iterations | Section 3.1 in [12] |
dx | δx perturbation too large | Section 3.1 in [12] |
e | Cutting back α due to evaluation error | in backtracking line search |
F- | Filter should be reset, but maximal resets exceeded | Section 2.3 in [12] |
F+ | Resetting filter due to last few rejections of filter | Section 2.3 in [12] |
L | Degenerate Jacobian, δc already perturbed | Section 3.1 in [12] |
l | Degenerate Jacobian, δc perturbed | Section 3.1 in [12] |
M | Magic step taken for slack variables | in backtracking line search |
Nh | Hessian not yet degenerate | Section 3.1 in [12] |
Nhj | Hessian/Jacobian not yet degenerate | Section 3.1 in [12] |
Nj | Jacobian not yet degenerate | Section 3.1 in [12] |
NW | Warm start initialization failed | in Warm Start Initialization |
q | PD system possibly singular, attempt improving sol. quality | Section 3.1 in [12] |
R | Solution of restoration phase | Section 3.3 in [12] |
S | PD system possibly singular, accept current solution | Section 3.1 in [12] |
s | PD system singular | Section 3.1 in [12] |
s | Square Problem. Set multipliers to zero | Default initialization routine |
Tmax | Trial θ is larger than θmax | filter parameter, see (21) in [12] |
W | Watchdog line search procedure successful | Section 3.2 in [12] |
w | Watchdog line search procedure unsuccessful, stopped | Section 3.2 in [12] |
Wb | Undoing most recent SR1 update | Section 5.4.1 in [1] |
We | Skip Limited-Memory Update in restoration phase | Section 5.4.1 in [1] |
Wp | Safeguard \(B^0 = \sigma I\) for Limited-Memory Update | Section 5.4.1 in [1] |
Wr | Resetting Limited-Memory Update | Section 5.4.1 in [1] |
Ws | Skip Limited-Memory Update since \(s^Ty\) is not positive | Section 5.4.1 in [1] |
WS | Skip Limited-Memory Update since Δx is too small | Section 5.4.1 in [1] |
y | Dual infeasibility, use least square multiplier update | during ipopt algorithm |
z | Apply correction to bound multiplier if too large | during ipopt algorithm |