XPRBvar

XPRBvar();
XPRBvar(xbvar *v);

v	A variable in BCL C.

Create a new variable object.

int fix(double val);

val	The value to which the variable is to be fixed.

This method fixes a variable to the given value. It replaces calls to XPRBvar.setLB and XPRBvar.setUB. The value val may lie outside the original bounds of the variable. If the problem is loaded in the Optimizer, the bound change is passed on immediately without any need to reload the problem.

Calls XPRBfixvar

int getColNum();

This method returns the column number of a variable in the matrix currently loaded in the Xpress Optimizer. If the variable is not part of the matrix, or if the matrix has not yet been generated, the function returns a negative value. To check whether the matrix has been generated, use function XPRBprob.getProbStat. The counting of column numbers starts with 0.

Calls XPRBgetcolnum

xbvar *getCRef();

This method returns the variable object in BCL C that belongs to the C++ variable object.

double getLB();

This method returns the currently defined lower bound on a variable.

Calls XPRBgetbounds

double getLim();

This method returns the currently defined integer limit for a partial integer variable or the lower semi-continuous limit for a semi-continuous or semi-continuous integer variable.

Calls XPRBgetlim

const char *getName();

This method returns the name of a variable. If the user has not defined a name the default name generated by BCL is returned.

Calls XPRBgetvarname

double getRCost();

This method returns the reduced cost value for a variable. The user may wish to test first whether this variable is part of the problem, for instance by checking that the column number is non-negative.
Reduced cost information is available only after LP solving. To obtain reduced cost values for a MIP solution (that is, if function XPRBprob.getMIPStat returns values XPRB_MIP_SOLUTION or XPRB_MIP_OPTIMAL), you need to fix the discrete variables to their solution values with a call to XPRSfixmipentities, followed by a call to XPRBlpoptimize before calling XPRBgetrcost. Otherwise, if this function is called when a MIP solution is available it returns 0.
If no solution information is available this function outputs a warning and returns 0.
If this function is used during the execution of an optimization process (for instance in Optimizer library callback functions) it needs to be preceded by a call to XPRBprob.sync with the flag XPRB_XPRS_SOL. In this case it returns the reduced cost value in the last LP that has been solved.

Calls XPRBgetrcost

double getRNG(int rngtype);

rngtype	The type of ranging information sought. This is one of: XPRB_UUP  the change in objective value per unit increase in the variable activity, assuming the the current basis remains optimal; XPRB_UDN  the change in objective value per unit decrease in the variable activity, assuming the the current basis remains optimal; XPRB_UCOST  the largest value which this variable's objective coefficient can take while the current basis remains optimal; XPRB_LCOST  the smallest value which this variable's objective coefficient can take while the current basis remains optimal;
XPRB_UPACT	for a variable which is at one of its bounds, the largest value which that bound can take while the current basis remains optimal;
XPRB_LOACT	for a variable which is at one of its bounds, the smallest value which that bound can take while the current basis remains optimal.

Calls XPRBgetvarrng

double getSol();

This function returns the current solution value for a variable. The user may wish to test first whether this variable is part of the problem, for instance by checking that the column number is non-negative.
If this function is called after completion of a branch and bound tree search and an integer solution has been found (that is, if function XPRBprob.getMIPStat returns values XPRB_MIP_SOLUTION or XPRB_MIP_OPTIMAL), it returns the value of the best integer solution. If no integer solution is available after a branch and bound tree search this function outputs a warning and returns 0. In all other cases it returns the solution value in the last LP that has been solved. If this function is used during the execution of an optimization process (for instance in Optimizer library callback functions) it needs to be preceded by a call to XPRBprob.sync with the flag XPRB_XPRS_SOL.

Calls XPRBgetsol

int getType();

XPRB_PL	continuous;
XPRB_BV	binary;
XPRB_UI	general integer;
XPRB_PI	partial integer;
XPRB_SC	semi-continuous;
XPRB_SI	semi-continuous integer;
-1	an error has occurred.

If the function exits successfully, the variable type is returned.

Calls XPRBgetvartype

double getUB();

This method returns the currently defined upper bound on a variable.

Calls XPRBgetbounds

bool isValid();

This method checks whether the variable object is correctly defined. It should always be used to test the result returned by XPRBprob.getVarByName.

int print();

This method prints out a variable.

Calls XPRBprintvar

int setDir(int type, double val);
int setDir(int type);

type	Directive type, which must be one of: XPRB_PR  priority; XPRB_UP  first branch upwards; XPRB_DN  first branch downwards; XPRB_PU  pseudo cost on branching upwards; XPRB_PD  pseudo cost on branching downwards.
val	An argument dependent on the type of directive to be defined. Must be one of: XPRB_PR  priority value — an integer between 1 (highest) and 1000 (least priority), the default; XPRB_UP  no input required; XPRB_DN  no input required; XPRB_PU  value of the pseudo cost on branching upwards; XPRB_PD  value of the pseudo cost on branching downwards.

Calls XPRBsetvardir

int setLB(double val);

val	The variable's new lower bound.

This method sets the lower bound on a variable. If the problem is loaded in the Optimizer, the bound change is passed on immediately without any need to reload the problem.

Calls XPRBsetlb

int setLim(double val);

val	Value of the integer limit.

This method sets the integer limit ( i.e. the lower bound of the continuous part) of a partial integer variable or the semi-continuous limit of a semi-continuous or semi-continuous integer variable to the given value.

Calls XPRBsetlim

int setType(int type);

type	The variable type, which is one of: XPRB_PL  continuous; XPRB_BV  binary; XPRB_UI  general integer; XPRB_PI  partial integer; XPRB_SC  semi-continuous; XPRB_SI  semi-continuous integer.

This method changes the type of a variable that has been created previously.

Calls XPRBsetvartype

int setUB(double val);

val	The variable's new upper bound.

This method sets the upper bound on a variable. If the problem is loaded in the Optimizer, the bound change is passed on immediately without any need to reload the problem.

Calls XPRBsetub