WOLFRAM

Wolfram Language & System Documentation Center
IPOPTReturnCode[data] gives the IPOPT solver return code from an IPOPTData expression data.
Details and Options
Details and Options Details and Options
Examples  
Basic Examples  
Related Guides
Cite this Page
IPOPTLink`
IPOPTLink`

IPOPTReturnCode

IPOPTReturnCode[data] gives the IPOPT solver return code from an IPOPTData expression data.

Details and Options

  • To use IPOPTReturnCode, you first need to load it using Needs["IPOPTLink`"].
  • IPOPTReturnCode is used on an IPOPTData expression created by IPOPTMinimize.
  • The following codes may be returned by the IPOPT solver, with short descriptions from the IPOPT documentation:
  • 0Optimal solution found
    1Solved to acceptable level
    2Converged to a point of local infeasibility. Problem may be infeasible
    3Search direction is becoming too small
    4Iterates diverging; problem might be unbounded
    5Stopping optimization at current point as requested by user
    6Feasible point for square problem found
    -1Maximum number of iterations exceeded
    -2Restoration failed
    -3Error in step computation (regularization becomes too large?)
    -4Maximum CPU time exceeded
    -10Problem has too few degrees of freedom
    -11Invalid problem definition
    -12Invalid option
    -13Invalid number detected
    -100Unrecoverable exception
    -101Unknown exception caught in Ipopt
    -102Not enough memory
    -199Internal IPOPT error: unknown SolverReturn value

Examples

Basic Examples  (2)

First, load the package:

Wolfram Language code: Needs["IPOPTLink`"]

Solve a minimization problem using IPOPTMinimize:

Wolfram Language code: sol = IPOPTMinimize[-Log[a * E ^ (1 - a)], {a}, {1.}, {{0., 1.*^40}}]

Extract the return code:

Wolfram Language code: IPOPTReturnCode[sol]

Load the package:

Wolfram Language code: Needs["IPOPTLink`"]

Solve a minimization problem where an overflow happens and $Failed is returned by default.

Wolfram Language code: sol = IPOPTMinimize[-Log[a * E ^ (a - 1)], {a}, {1000.}, {{0., 1.*^40}}]

Return a solution object so that we can extract the error code, and turn off the messages:

Wolfram Language code: sol = IPOPTMinimize[-Log[a * E ^ (a - 1)], {a}, {1000.}, {{0., 1.*^40}}, "RuntimeOptions" -> {"RuntimeErrorHandler" -> "ReturnObject", "WarningMessages" -> False}]

Extract the return code:

Wolfram Language code: IPOPTReturnCode[sol]
Wolfram Research (2016), IPOPTReturnCode, Wolfram Language function, https://reference.wolfram.com/language/IPOPTLink/ref/IPOPTReturnCode.html.

Text

Wolfram Research (2016), IPOPTReturnCode, Wolfram Language function, https://reference.wolfram.com/language/IPOPTLink/ref/IPOPTReturnCode.html.

CMS

Wolfram Language. 2016. "IPOPTReturnCode." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/IPOPTLink/ref/IPOPTReturnCode.html.

APA

Wolfram Language. (2016). IPOPTReturnCode. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/IPOPTLink/ref/IPOPTReturnCode.html

BibTeX

@misc{reference.wolfram_2026_ipoptreturncode, author="Wolfram Research", title="{IPOPTReturnCode}", year="2016", howpublished="\url{https://reference.wolfram.com/language/IPOPTLink/ref/IPOPTReturnCode.html}", note=[Accessed: 15-June-2026]}

BibLaTeX

@online{reference.wolfram_2026_ipoptreturncode, organization={Wolfram Research}, title={IPOPTReturnCode}, year={2016}, url={https://reference.wolfram.com/language/IPOPTLink/ref/IPOPTReturnCode.html}, note=[Accessed: 15-June-2026]}