Initializing help system before first use

XSLPgetvar

Purpose
This subroutine is deprecated and will be removed in a future release.
Retrieve information about an SLP variable.
Topic area
Synopsis
int XPRS_CC XSLPgetvar(XSLPprob prob, int col, int *p_detrow, double *p_initstepbound, double *p_stepbound, double *p_penalty, double *p_damp, double *p_initial, double *p_value, int *p_tolset, int *p_history, int *p_converged, int *p_vartype, int *p_delta, int *p_penaltydelta, int *p_updaterow, double *p_old);
Arguments
prob 
The current SLP problem.
col 
The index of the column.
p_detrow 
Address of an integer to receive the index of the determining row. May be NULL if not required.
p_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.
p_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.
p_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.
p_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.
p_initial 
Address of a double precision variable to receive the value of the initial value of the variable. May be NULL if not required.
p_value 
Address of a double precision variable to receive the current activity of the variable. May be NULL if not required.
p_tolset 
Address of an integer to receive the index of the tolerance set of the variable. May be NULL if not required.
p_history 
Address of an integer to receive the SLP history of the variable. May be NULL if not required.
p_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 NULL if not required.
p_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.
p_delta 
Address of an integer to receive the index of the delta vector for the variable. May be NULL if not required.
p_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 NULL if not required.
p_updaterow 
Address of an integer to receive the index of the update row for the variable. May be NULL if not required.
p_old 
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 converged, history;
double value;

XSLPgetvar(prob, 3, NULL, NULL, NULL,
           NULL, NULL, NULL, &value,
           NULL, &history, &converged,
           NULL, NULL, NULL, NULL, NULL);
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.

p_detrow will be set to -1 if there is no determining row.

p_delta, p_penaltydelta and p_updaterow will be set to -1 if there is no corresponding item.

Current values, deltas and step bounds can also be obtained individually through XSLPgetcolinfo.


Related topics

© 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.