tutoriali.py

Functions
	tutoriali.TutModelData.buildModel (self)
	adding the variables and constraints to the model
	tutoriali.TutModelData.initFDEvaluation (self, x, rowlist, mode, numthread, ignerr)
	callback method for initialising the first derivative evaluation.
	tutoriali.TutModelData.evaluateNonlinearTerm (self, x, rowno, ignerr, thread)
	callback method for evaluating the nonlinear terms in a given row
	tutoriali.TutModelData.evaluateNonlinearJacobian (self, x, rowno, jacnum, ignerr, thread)
	callback method for evaluating the jacobian for the nonlinear terms in a given row

Detailed Description

This model is a revision of Tutorial in which we have added a an initialization callback for the First derivative, Tut_FDEvalIni.

For more information about the individual callbacks, please have a look at the source code.

Function Documentation

buildModel()

tutoriali.TutModelData.buildModel

(

self

)

adding the variables and constraints to the model

Definition at line 34 of file tutoriali.py.

initFDEvaluation()

tutoriali.TutModelData.initFDEvaluation	(		self,
			x,
			rowlist,
			mode,
			numthread,
			ignerr )

callback method for initialising the first derivative evaluation.

If defined, this method will be called each time the point of interest has changed, and it will define the coming point and tell which constraints CONOPT will need during the following calls to evaluateNonlinearTerm and evaluateNonlinearJacobian.

Parameters

x	the solution vector that needs to be evaluated.
rowlist	the list of rows that will be evaluated for the given point.
mode	the evaluation mode for the current iteration. This is either TermsOnly, JacobianOnly or Both. See EvaluationMode for more details.
numthread	the number of threads that will be used for the following FDEval calls.
ignerr	a boolean to indicate whether the current point is safe or unsafe.

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

Reimplemented from pyconopt.ModelData.

Definition at line 60 of file tutoriali.py.

evaluateNonlinearTerm()

tutoriali.TutModelData.evaluateNonlinearTerm	(		self,
			x,
			rowno,
			ignerr,
			thread )

callback method for evaluating the nonlinear terms in a given row

Parameters

x	the solution vector that needs to be evaluated.
rowno	the number for the row in which the nonlinear term exists.
ignerr	a boolean to indicate whether the current point is safe or unsafe.
thread	the 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()

Reimplemented from pyconopt.ModelData.

Definition at line 76 of file tutoriali.py.

evaluateNonlinearJacobian()

tutoriali.TutModelData.evaluateNonlinearJacobian	(		self,
			x,
			rowno,
			jacnum,
			ignerr,
			thread )

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

Parameters

x	the solution vector that needs to be evaluated.
rowno	the number for the row in which the nonlinear term exists.
jacnum	vector with a list of column numbers for the nonlinear nonzero Jacobian elements in the row.
ignerr	a boolean to indicate whether the current point is safe or unsafe.
thread	the 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()

Reimplemented from pyconopt.ModelData.

Definition at line 88 of file tutoriali.py.