CONOPT
Loading...
Searching...
No Matches
Evaluating non-linear function values and derivatives

Functions

 conopt.ModelData.evaluateNonlinearTerm (self, x, rowno, ignerr, thread)
 callback method for evaluating the nonlinear terms in a given row
 
 conopt.ModelData.evaluateNonlinearJacobian (self, x, rowno, jacnum, ignerr, thread)
 callback method for evaluating the jacobian for the nonlinear terms in a given row
 
 conopt.ModelData.endFDEvaluation (self, ignerr)
 Optional function, if defined, it will be called at the end of the function evaluation stage.
 

Detailed Description

Virtual functions to be implemented by the user for the evaluation of non-linear functions and derivatives.

Function Documentation

◆ evaluateNonlinearTerm()

conopt.ModelData.evaluateNonlinearTerm ( self,
x,
rowno,
ignerr,
thread )

callback method for evaluating the nonlinear terms in a given row

Parameters
xthe solution vector that needs to be evaluated.
rownothe number for the row in which the nonlinear term exists.
ignerra boolean to indicate whether the current point is safe or unsafe.
threadthe index of the thread from which this method is being called from.
Returns
the value of the nonlinear terms.

Notes: an error in the evaluation is reported by calling errorInEvaluation()

Definition at line 2436 of file conopt.py.

◆ evaluateNonlinearJacobian()

conopt.ModelData.evaluateNonlinearJacobian ( self,
x,
rowno,
jacnum,
ignerr,
thread )

callback method for evaluating the jacobian for the nonlinear terms in a given row

Parameters
xthe solution vector that needs to be evaluated.
rownothe number for the row in which the nonlinear term exists.
jacnumvector with a list of column numbers for the nonlinear nonzero Jacobian elements in the row.
ignerra boolean to indicate whether the current point is safe or unsafe.
threadthe index of the thread from which this method is being called from.
Returns
a vector the length of jacnum that contains the jacobian values for the referenced elements.

Notes: an error in the evaluation is reported by calling errorInEvaluation()

Definition at line 2453 of file conopt.py.

◆ endFDEvaluation()

conopt.ModelData.endFDEvaluation ( self,
ignerr )

Optional function, if defined, it will be called at the end of the function evaluation stage.

This can be used to clean up any user data generated, such as in FDEvalIni, that was used to improve the efficiency of the function and derivative evaluation.

Parameters
ignerra boolean to indicate whether the current point is safe or unsafe.

Notes: an error in the evaluation is reported by calling errorInEvaluation()

Definition at line 2492 of file conopt.py.