[Previous] [Next]

getstatus

---

Purpose

Return the status value of an mpvar

Synopsis

function getstatus(v:mpvar | i:integer) :integer

Arguments

v	an mpvar
i	an integer, being the index of an mpvar

Return value

The SLP status value of the mpvar

Example

The following code fragment checks the status of variable v(i) and if the variable has a step bound, the value of the bound is retrieved:

if bittest(getstatus(v(i)),131072) > 0 then
  sb := getstepbound(v(i))

Further information

For SLP variables, the status contains information about the variable as a bit pattern. The following bits are potentially useful:

16 (=65536)

Variable has converged

17 (=131072)

Variable has an active step bound

20 (=1048576)

Variable is not an SLP variable

Other bits are set for internal use, so the bits should always be tested using the bittest function.

If the argument is an integer, it is interpreted as the index of an mpvar.

[Previous] [Next] [Index]

---

If you have any comments or suggestions about these pages, please send mail to docs@dashoptimization.com.