Mandatory callback routines

Functions
integer function	coidef_readmatrix (cntvect, coi_readmatrix)
	define callback routine for providing the matrix data to CONOPT.
integer function	coidef_fdeval (cntvect, coi_fdeval)
	define callback routine for performing function and derivative evaluations.
integer function	coidef_status (cntvect, coi_status)
	define callback routine for returning the completion status.
integer function	coidef_solution (cntvect, coi_solution)
	define callback routine for returning the final solution values.
integer function	coidef_message (cntvect, coi_message)
	define callback routine for handling messages returned during the solution process.
integer function	coidef_errmsg (cntvect, coi_errmsg)
	define callback routine for returning error messages for row, column or Jacobian elements.

Detailed Description

The callback routines that must be implemented by the user.

The mandatory callback routines cover the key components of the solution algorithm. These include methods to read the matrix, evaluate non-linear functions and their first derivative, message handling and the reporting of solutions and statuses. It is not possible to run CONOPT without first implementing these callbacks.

Function Documentation

coidef_readmatrix()

integer function coidef_readmatrix	(	integer, dimension(numcallback)	cntvect,
		external	coi_readmatrix )

define callback routine for providing the matrix data to CONOPT.

CONOPT gets information about the structure of the model from a user written callback routine referred to as ReadMatrix. You must register this routine with a call to this method before CONOPT is started. The name of your version of ReadMatrix must be declared as external.

Note

There is no type checking for the argument list on External functions in Fortran, so you must be very careful.

Parameters

cntvect	the control vector
coi_readmatrix	the pointer to the user-defined ReadMatrix callback routine

Definition at line 1949 of file coistart.f90.

coidef_fdeval()

integer function coidef_fdeval	(	integer, dimension(numcallback)	cntvect,
		external	coi_fdeval )

define callback routine for performing function and derivative evaluations.

CONOPT get information about the nonlinearities from a user written callback routine referred to as FDEval. You must register this routine with a call to this method before CONOPT is started. The name of your version of FDEval must be declared as external.

Parameters

cntvect	the control vector
coi_fdeval	pointer to the user-defined FDEval callback routine

Definition at line 2023 of file coistart.f90.

coidef_status()

integer function coidef_status	(	integer, dimension(numcallback)	cntvect,
		external	coi_status )

define callback routine for returning the completion status.

When CONOPT has finished optimizing it informs the modeler about the status of the solution: Optimal, Infeasible, Normal completion, Interrupted by function evaluation errors etc. This is done by a call to a user written callback routine referred to as Status. You must register this routine with a call to this method before CONOPT is started. The name of your version of Status must be declared as external.

Parameters

cntvect	the control vector
coi_status	pointer to the user-defined Status callback routine

Definition at line 2098 of file coistart.f90.

coidef_solution()

integer function coidef_solution	(	integer, dimension(numcallback)	cntvect,
		external	coi_solution )

define callback routine for returning the final solution values.

After the user written callback Status has been called CONOPT will usually (unless the Status indicates some serious error condition) call another user written callback routine called Solution to inform the modeler about the actual primal and dual solution values. You must register this routine with a call to this method before CONOPT is started. The name of your version of Solution must be declared as external.

Parameters

cntvect	the control vector
coi_solution	the pointer to the user-defined Solution callback routine

Definition at line 2136 of file coistart.f90.

coidef_message()

integer function coidef_message	(	integer, dimension(numcallback)	cntvect,
		external	coi_message )

define callback routine for handling messages returned during the solution process.

Apart from the solution itself, CONOPT provides a number of messages about progress and problems during the optimization. Most messages are provided in the form of character strings that are passed as arguments to a user written callback routine called Message. It is the modelers responsibility to handle these messages. You must register this routine with a call to this method before CONOPT is started. The name of your version of Message must be declared as external.

Parameters

cntvect	the control vector
coi_message	the pointer to the user-defined Message callback routine

Definition at line 2175 of file coistart.f90.

coidef_errmsg()

integer function coidef_errmsg	(	integer, dimension(numcallback)	cntvect,
		external	coi_errmsg )

define callback routine for returning error messages for row, column or Jacobian elements.

Certain messages, including error messages, refer to a particular variable and/or constraint. The mandatory ErrMsg callback routine is used to format and display these messages. If you want to supply it you must register it with a call to this method before CONOPT is started. The name of your version of ErrMsg must be declared as external.

Parameters

cntvect	the control vector
coi_errmsg	pointer to the user-defined ErrMsg callback routine

Definition at line 2292 of file coistart.f90.