Purpose
Retrieve information about an SLP variable
Synopsis
int XPRS_CC XSLPgetvar(XSLPprob prob, int ColIndex, int *DetRow,
double *InitStepBound, double *StepBound, double *Penalty,
double *Damp, double *InitValue, double *Value, int *TolSet,
int *History, int *Converged, int *VarType, int *Delta,
int *PenaltyDelta, int *UpdateRow, double *OldValue);
Arguments
|
Prob
|
The current SLP problem.
|
|
ColIndex
|
The index of the column. This respects the setting of
XPRS_CSTYLE.
|
|
DetRow
|
Address of an integer to receive the index of the determining row.
This respects the setting of XPRS_CSTYLE. May be NULL if not required.
|
|
InitStepBound
|
Address of a double precision variable to receive the value of
the initial step bound of the variable. May be NULL if not required.
|
|
StepBound
|
Address of a double precision variable to receive the value of the
current step bound of the variable. May be NULL if not required.
|
|
Penalty
|
Address of a double precision variable to receive the value of the
penalty delta weighting of the variable. May be NULL if not required.
|
|
Damp
|
Address of a double precision variable to receive the value of the
current damping factor of the variable. May be NULL if not required.
|
|
InitValue
|
Address of a double precision variable to receive the value of the
initial value of the variable. May be NULL if not required.
|
|
Value
|
Address of a double precision variable to receive the current activity
of the variable. May be NULL if not required.
|
|
TolSet
|
Address of an integer to receive the index of the tolerance set of
the variable. May be NULL if not required.
|
|
History
|
Address of an integer to receive the SLP history of the variable.
May be NULL if not required.
|
|
Converged
|
Address of an integer to receive the convergence status of the
variable (see the section on "Convergence Criteria" for more information). May be
NULL 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:
|
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 NULL if not required.
|
|
Delta
|
Address of an integer to receive the index of the delta vector for the
variable. This respects the setting of XPRS_CSTYLE. May be NULL if not required.
|
|
PenaltyDelta
|
Address of an integer to receive the index of the first penalty
delta vector for the variable. This respects the setting of XPRS_CSTYLE. The second
penalty delta immediately follows the first. May be NULL if not required.
|
|
UpdateRow
|
Address of an integer to receive the index of the update row for
the variable. This respects the setting of XPRS_CSTYLE. May be NULL if not required.
|
|
OldValue
|
Address of a double precision variable to receive the value of the
variable at the previous SLP iteration. May be NULL if not required.
|
Example
The following example retrieves the current value, convergence history and
status for column 3.
int Status, History;
double Value;
XSLPgetvar(Prob, 3, NULL, NULL, NULL,
NULL, NULL, NULL, &Value,
NULL, &History, &Converged,
NULL, NULL, NULL, NULL, NULL);
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 0-XPRS_CSTYLE
if there is no corresponding item.
Related topics
If you have any comments or suggestions about these pages,
please send mail to docs@dashoptimization.com.