CONOPT comes with a Fortran and C API. This page will provide a detailed overview of both APIs. Since CONOPT is written in Fortran, all references are to the Fortan API. In addition to the API reference, the callback definitions are provided. Callbacks are an important part of the CONOPT API, since this is the main way for the user to interact with the solution algorithm. Finally, a list of the example applications and source code is provided.

[detail level 12345]

►The public API of CONOPT	The public API for interfacing with CONOPT. APIs exist for Fortran, C, C++, Python and Java
►Fortran API	The Fortran public API
Utility Routines	This section describes utility routines in the CONOPT DLL
►Initialisation Methods	Initialisation methods that must or can be used before CONOPT is started
The Control Vector	The Control Vector is the main communication region between the modeler and CONOPT
Registration of problem sizes	Before any model data can be loaded into CONOPT, the dimensions of the problem must be first specified
Registration of options	Options that modify the macro behaviour of CONOPT
►Registration of callback routines	Registration methods for callback routines to interact with the CONOPT solution algorithm
Mandatory callback routines	The callback routines that must be implemented by the user
Optional callback routines	The callback routines that can be used to enhance the solution algorithm
►Definition of Callback Functions	A detailed overview of the callback function defintions
Defining the Model	Providing the matrix information and initial values to CONOPT
Evaluating Non-linear Function Values and Derivatives	Methods for computing the values and derivatives for non-linear functions
►Defining Second Order Information	Methods for computing second order information for non-linear functions
Computing the Hessian of the Lagrangian
Computing the second derivative on constraint in a direction
Second derivative of the Lagrangian in a direction
Message Passing and Error Reporting	General messaging callback and optional error reporting callback
Returning the Solution	Methods for returning the final solution and optimisation status
Non-default Options	Enables the user to provide an options file and set individual options
►C API	The C public API
Utility Routines	This section describes utility routines in the CONOPT DLL.
►Initialisation Methods	Initialisation methods that must or can be used before CONOPT is started.
The Control Vector	The Control Vector is the main communication region between the modeler and CONOPT.
Registration of problem sizes	Before any model data can be loaded into CONOPT, the dimensions of the problem must be first specified.
Registration of options	Options that modify the macro behaviour of CONOPT.
►Registration of callback routines	Registration methods for callback routines to interact with the CONOPT solution algorithm.
Mandatory callback routines	The callback routines that must be implemented by the user.
Optional callback routines	The callback routines that can be used to enhance the solution algorithm.
►Definition of Callback Functions	A detailed overview of the callback function defintions.
Defining the Model	Providing the matrix information and initial values to CONOPT.
Evaluating Non-linear Function Values and Derivatives	Methods for computing the values and derivatives for non-linear functions.
►Defining Second Order Information	Methods for computing second order information for non-linear functions.
Computing the Hessian of the Lagrangian
Computing the second derivative on constraint in a direction
Second derivative of the Lagrangian in a direction
Message Passing and Error Reporting	General messaging callback and optional error reporting callback.
Returning the Solution	Methods for returning the final solution and optimisation status.
Non-default Options	Enables the user to provide an options file and set individual options.
►C++ API	The C++ public API
►ConoptCpp Class	The control class for the CONOPT C++ api
Utility Routines	This section describes utility routines in the CONOPT DLL.
Solution Status methods	Methods for querying the solution status
Model data methods	Methods for loading the model data
Message handler methods	Methods for loading and using a user-defined message handler
Registration of sizes	Before any model data can be loaded into CONOPT, the dimensions of the problem must be first specified.
Registration of options	Options that modify the macro behaviour of CONOPT.
►ConoptModelData Class	A necessary class for defining the model data and function evaluations
Defining the model	Methods that are used to define the model to be solved by CONOPT
Querying the model	Methods to query information about the model
Evaluating non-linear function values and derivatives	Virtual functions to be implemented by the user for the evaluation of non-linear functions and derivatives
Defining the second derivative	Virtual functions that can be optionally implemented by the user to define the second order derivatives
ConoptMessageHandler Class	An optional class for providing a custom message handler
►Python API	The Python public API
►Conopt Class	The control class for the CONOPT C++ api
Utility Routines	This section describes utility routines in the CONOPT DLL.
Solution Status methods	Methods for querying the solution status
Model data methods	Methods for loading the model data
Message handler methods	Methods for loading and using a user-defined message handler
Registration of sizes	Before any model data can be loaded into CONOPT, the dimensions of the problem must be first specified.
Registration of options	Options that modify the macro behaviour of CONOPT.
►ModelData Class	A necessary class for defining the model data and function evaluations
Defining the model	Methods that are used to define the model to be solved by CONOPT
Querying the model	Methods to query information about the model
Evaluating non-linear function values and derivatives	Virtual functions to be implemented by the user for the evaluation of non-linear functions and derivatives
Defining the second derivative	Virtual functions that can be optionally implemented by the user to define the second order derivatives
MessageHandler Class	An optional class for providing a custom message handler
►Java API	The Java public API
►Conopt Class	The control class for the CONOPT C++ api
Utility Routines	This section describes utility routines in the CONOPT DLL.
Solution Status methods	Methods for querying the solution status
Model data methods	Methods for loading the model data
Message handler methods	Methods for loading and using a user-defined message handler
Registration of sizes	Before any model data can be loaded into CONOPT, the dimensions of the problem must be first specified.
Registration of options	Options that modify the macro behaviour of CONOPT.
►ModelData Class	A necessary class for defining the model data and function evaluations
Defining the model	Methods that are used to define the model to be solved by CONOPT
Querying the model	Methods to query information about the model
Evaluating non-linear function values and derivatives	Virtual functions to be implemented by the user for the evaluation of non-linear functions and derivatives
Defining the second derivative	Virtual functions that can be optionally implemented by the user to define the second order derivatives
MessageHandler Class	An optional class for providing a custom message handler
►Public API files	The source files that define the public API
C++ API	The source files that define the public C++ API
Java API	The source files that define the public Java API
Additional Information	Some additional details and options related to the CONOPT solution algorithm
►Examples using CONOPT	Examples written in Fortran, C, C++, Python and Java demonstrating how to directly interface with CONOPT
Fortran - Single Thread	Examples written in Fortran that use a single thread
C - Single Thread	Examples written in C that use a single thread
►C++ - Single Thread	Examples written in C++ that use a single thread
tutorial.cpp	a tutorial providing an introduction to the CONOPT API
tutorial2.cpp	This model is a revision of Tutorial in which we have added a set of 2nd derivative routines, Tut_2DLagrStr and Tut_2DLagrVal.
►Python - Single Thread	Examples written in Python that use a single thread
tutorial.py	a tutorial providing an introduction to the CONOPT API
tutorial2.py	This model is a revision of Tutorial in which we have added a set of 2nd derivative routines, Tut_2DLagrStr and Tut_2DLagrVal.
tutoriali.py	This model is a revision of Tutorial in which we have added a an initialization callback for the First derivative, Tut_FDEvalIni.
qp1.py	The current model is a simple QP model with a sparse Q matrix, bounded variables, and one constraint.
qp2.py	Similar to qp1 but uses directional 2nd derivatives.
qp3.py	Similar to qp1 but uses 2nd derivatives as a matrix.
qp4.py	A combination of qp2 and qp3.
►Java - Single Thread	Examples written in Java that use a single thread
tutorial.java	a tutorial providing an introduction to the CONOPT API
tutorial2.java	This model is a revision of Tutorial in which we have added a set of 2nd derivative routines, Tut_2DLagrStr and Tut_2DLagrVal.
tutoriali.java	This model is a revision of Tutorial in which we have added a an initialization callback for the First derivative, Tut_FDEvalIni.
qp1.java	The current model is a simple QP model with a sparse Q matrix, bounded variables, and one constraint.
qp2.java	Similar to qp1 but uses directional 2nd derivatives.
qp3.java	Similar to qp1 but uses 2nd derivatives as a matrix.
qp4.java	A combination of qp2 and qp3.
Fortran - Open MP	Examples written in Fortran that use Open MP for multithreading
C - Open MP	Examples written in C that use Open MP for multithreading