Initializing help system before first use

problem.getvar

Purpose
Retrieve information about an SLP variable
Synopsis
(detrow, initstepbound, stepbound, penalty, damp, initial, value, tolset, history, converged, vartype, delta, penaltydelta, updaterow, oldvalue) = problem.getvar(col)
Arguments
col 
The column (i.e. xpress.var object, index, or name).
detrow 
An integer to receive the index of the determining row. May be None if not required.
initstepbound 
A double precision variable to receive the value of the initial step bound of the variable. May be None if not required.
stepbound 
A double precision variable to receive the value of the current step bound of the variable. May be None if not required.
penalty 
A double precision variable to receive the value of the penalty delta weighting of the variable. May be None if not required.
damp 
A double precision variable to receive the value of the current damping factor of the variable. May be None if not required.
initial 
A double precision variable to receive the value of the initial value of the variable. May be None if not required.
value 
A double precision variable to receive the current activity of the variable. May be None if not required.
tolset 
An integer to receive the index of the tolerance set of the variable. May be None if not required.
history 
An integer to receive the SLP history of the variable. May be None if not required.
converged 
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 
An integer to receive the status settings (a bitmap defining the existence of certain properties for this variable). The following bits are defined:
Bit 1: 
Variable has a delta vector
Bit 2: 
Variable has an initial value
Bit 14: 
Variable is the reserved "=" column
Other bits are reserved for internal use. May be None if not required.
delta 
An integer to receive the index of the delta vector for the variable. May be None if not required.
penaltydelta 
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 
An integer to receive the index of the update row for the variable. May be None if not required.
oldvalue 
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 col 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
problem.addvars, problem.chgvar, problem.delvars, problem.loadvars

Parent Topic Xpress problem methods

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.