problem.getvar
problem.getvar |
Purpose
Retrieve information about an SLP variable
Synopsis
(detrow, initstepbound, stepbound, penalty, damp, initvalue, value, tolset, history, converged, vartype, delta, penaltydelta, updaterow, oldvalue) = problem.getvar (colindex)
Arguments
|
colindex
|
The index of the column.
|
||||||
|
detrow
|
Address of an integer to receive the index of the determining row. May be
None if not required.
|
||||||
|
initstepbound
|
Address of a double precision variable to receive the value of the initial step bound of the variable. May be
None if not required.
|
||||||
|
stepbound
|
Address of a double precision variable to receive the value of the current step bound of the variable. May be
None if not required.
|
||||||
|
penalty
|
Address of a double precision variable to receive the value of the penalty delta weighting of the variable. May be
None if not required.
|
||||||
|
damp
|
Address of a double precision variable to receive the value of the current damping factor of the variable. May be
None if not required.
|
||||||
|
initvalue
|
Address of a double precision variable to receive the value of the initial value of the variable. May be
None if not required.
|
||||||
|
value
|
Address of a double precision variable to receive the current activity of the variable. May be
None if not required.
|
||||||
|
tolset
|
Address of an integer to receive the index of the tolerance set of the variable. May be
None if not required.
|
||||||
|
history
|
Address of an integer to receive the SLP history of the variable. May be
None if not required.
|
||||||
|
converged
|
Address of an integer to receive the convergence status of the variable as defined in the "Convergence Criteria" section (The returned value will match the numbering of the tolerances). May be
None if not required.
|
||||||
|
vartype
|
Address of an integer to receive the status settings (a bitmap defining the existence of certain properties for this variable). The following bits are defined:
Other bits are reserved for internal use. May be
None if not required.
|
||||||
|
delta
|
Address of an integer to receive the index of the delta vector for the variable. May be
None if not required.
|
||||||
|
penaltydelta
|
Address of an integer to receive the index of the first penalty delta vector for the variable. The second penalty delta immediately follows the first. May be
None if not required.
|
||||||
|
updaterow
|
Address of an integer to receive the index of the update row for the variable. May be
None if not required.
|
||||||
|
oldvalue
|
Address of a double precision variable to receive the value of the variable at the previous SLP iteration. May be
None if not required.
|
Example
The following example retrieves the current value, convergence history and status for column 3.
(a,b,c,d,e,value,g,history,converged,j,k,i,h,k,l) = p.getvar (3)
Further information
If colindex refers to a column which is not an SLP variable, then all the return values will indicate that there is no corresponding data.
detrow will be set to -1 if there is no determining row.
delta, penaltydelta and updaterow will be set to -1 if there is no corresponding item.
Related topics