Learn R Programming

cplexAPI (version 1.4.0)

getIndConstrCPLEX: Access a Specified Indicator Constraint on the Variables of a CPLEX Problem Object.

Description

Low level interface function to the IBM ILOG CPLEX function CPXgetindconstr. Consult the IBM ILOG CPLEX documentation for more detailed information.

Usage

getIndConstrCPLEX(env, lp, which)

Arguments

env

An object of class "'>cplexPtr" as returned by openEnvCPLEX. This is basically a pointer to an IBM ILOG CPLEX environment.

lp

An object of class "'>cplexPtr" as returned by initProbCPLEX. This is basically a pointer to an IBM ILOG CPLEX problem object.

which

An integer specifying which indicator constraint to return.

Value

If successful a list is returned:

indvar

Index of the binary indicator variable. Consult the IBM ILOG CPLEX documentation for more detailed information.

complemented

Boolean value that specifies whether the indicator variable is complemented. Consult the IBM ILOG CPLEX documentation for more detailed information.

rhs

Righthand side value of the linear portion of the indicator constraint. Consult the IBM ILOG CPLEX documentation for more detailed information.

sense

Sense of the linear portion of the constraint. Consult the IBM ILOG CPLEX documentation for more detailed information.

linind

Variable indices of the entries of linval. Consult the IBM ILOG CPLEX documentation for more detailed information.

linval

Coefficients of the linear portion of the specified indicator constraint. Consult the IBM ILOG CPLEX documentation for more detailed information.

otherwise an instance of class "'>cplexError".

Details

Interface to the C function getIndConstr which calls the CPLEX function CPXgetindconstr.

References

The IBM ILOG CPLEX home page at https://www.ibm.com/support/knowledgecenter/SSSA5P.