Purpose
Return the convergence status of a variable
Synopsis
function getconverged(v:mpvar | i:integer) :integer
Arguments
|
v
|
an mpvar
|
|
i
|
an integer, being the index of an mpvar
|
Return value
The convergence status of the variable
Example
The following example shows part of a callback function which is used
to check the convergence status of a variable before attempting potentially more expensive
analysis:
function ConvergeTest(V: integer) : integer
if getconverged(V) = 0 then
returned := 0 ! variable has converged
else
! ... additional testing on variable
! ...
returned := 99
end-if
end-function
Further information
This function returns the convergence status of a variable. A status of zero
means the variable is not converged. Values 1 to 9 are reserved for convergence on
system-defined convergence criteria. Values of 10 or more are for convergence on
user-defined criteria.
If you have any comments or suggestions about these pages,
please send mail to docs@dashoptimization.com.