Learn R Programming

cplexAPI

R Interface to C API of IBM ILOG CPLEX, depends on IBM ILOG CPLEX (>= 12.1)

Copy Link

Version

Install

install.packages('cplexAPI')

Monthly Downloads

28

Version

1.4.0

License

GPL-3 | file LICENSE

Maintainer

Mayo Roettger

Last Published

September 21st, 2020

Functions in cplexAPI (1.4.0)

Write the Most Current Basis Associated With a CPLEX Problem Object to a File

Adds Columns to a Specified CPLEX Problem Object

Solve LP, QP or QCP Problem by Means of the Barrier Algorithm

addQConstrCPLEX

Add Quadratic Constraint to a Specified CPLEX Problem Object

Access Upper and Lower Sensitivity Ranges for Lower and Upper Variable Bounds

addIndConstrCPLEX

Adds an Indicator Constraint to the Specified CPLEX Problem Object

Add a File to the List of Message Destinations for a Channel

Add Constraints to a Specified CPLEX Problem Object

basicPresolveCPLEX

Perform Bound Strengthening and Detect Redundant Rows

checkCopyLpwNamesCPLEX

Validate Arguments of the Corresponding copyLpwNamesCPLEX Routine

checkCopyColTypeCPLEX

Validate Arguments of the Corresponding copyColTypeCPLEX Routine

addMIPstartsCPLEX

Add Multiple MIP Starts to a CPLEX Problem Object

checkCopyQPsepCPLEX

Validate Arguments of the Corresponding copyQPsepCPLEX Routine

Write an LP Format File Containing Identified Conflict

chgColTypeCPLEX

Change Types of a Set of Variables of a CPLEX Problem Object

Change the Lower or Upper Bounds on a Set of Variables of a Problem

Change a Single Coefficient in the Constraint Matrix, Linear Objective Coefficients, Righthand Side, or Ranges of a CPLEX Problem Object

Check an Array of Indices and a Corresponding Array of Values for Input Errors

checkCopyQuadCPLEX

Validate Arguments of the Corresponding checkCopyQuadCPLEX Routine

chgRowNameCPLEX

Change Names of Linear Constraints

Change the Name of a Constraint a Variable in a CPLEX Problem Object.

chgMIPstartsCPLEX

Modify or Extend Multiple MIP Starts

checkAddColsCPLEX

Validate Arguments of the Corresponding addColsCPLEX Routine

checkCopyLpCPLEX

Validate Arguments of the Corresponding copyLpCPLEX Routine

Change Sense of a Set of Linear Constraints

Copy the Quadratic Objective Matrix Q for a Separable QP Problem

Change Linear Objective Coefficients

Copy Priority Order to CPLEX Problem Object

checkAddRowsCPLEX

Validate Arguments of the Corresponding addRowsCPLEX Routine

chgProbTypeCPLEX

Change the Current Problem to a Related Problem

Copy a CPLEX Problem Object

checkChgCoefListCPLEX

Validate Arguments of the Corresponding chgCoefListCPLEX Routine

Change a Single Coefficient in the Quadratic Objective of a Quadratic Problem

completelpCPLEX

Manage Modification Steps Closely

chgProbNameCPLEX

Change the Name of the Current Problem.

Free all of the Data Structures Associated With CPLEX

chgColsBndsCPLEX

Change Lower and Upper Bounds on a Set of Variables of a Problem

Copies a Basis Into a CPLEX Problem Object.

chgTerminateCPLEX

Change Termination Signal

copyLpwNamesCPLEX

Copy Data Defining an LP Problem to a CPLEX Problem Object.

copyObjNameCPLEX

Copy a Name for the Objective Function Into a CPLEX Problem Object.

chgCoefListCPLEX

Change a List of Matrix Coefficients of a CPLEX Problem Object

chgColNameCPLEX

Change the Names of Variables in a CPLEX Problem Object

cleanupCoefCPLEX

change Problem Coefficients to Zero That are Smaller in Magnitude Than the Tolerance Specified in the Argument eps

Copy Data Defining an LP Problem to a CPLEX Problem Object.

copyColTypeCPLEX

Copy Variable Type Information Into a Given Problem

Change Range Coefficients

Change Righthand Side Coefficients

cplexAPI-package

R Interface to C API of IBM ILOG CPLEX

Constants, Parameters, Return and Status Codes of IBM ILOG CPLEX

Class "cplexPtr"

Delete a Range of Rows

Close CPLEX Environment And Remove CPLEX Problem Object

cplexError-class

Class "cplexError"

delQConstrsCPLEX

Delete a Range of Quadratic Constraints

Delete all Columns in a Specified Range

Remove all Names Assigned to Rows and Columns

Remove Specified CPLEX Problem Object

Remove a File from the List of Message Destinations for a Channel

Copy a Quadratic Objective Matrix Q When Q is not Diagonal.

flushStdChannelsCPLEX

Flushes the Output Buffers of the Four Standard Channels

getColIndexCPLEX

Search for the Index Number of the Specified Column

Provides Starting Information for Use in a Subsequent Call to a Simplex Optimization Routine.

flushChannelCPLEX

Flush All Message Destinations Associated With a Channel

freePresolveCPLEX

Free Presolved Problem From the LP Problem Object

getErrorStrCPLEX

Return an Error Message String Corresponding to an Error Code

getColInfeasCPLEX

Compute Infeasibility of a Given Solution for a Range of Variables

Project the Impact of Making Changes to Optimal Variable Values or Objective Function Coefficients

Access Basis Resident in a CPLEX Problem Object.

getIntQualCPLEX

Access Integer-Valued Information About the Quality of the Current Solution of a Problem

Access MIP Cutoff Value Being Used During Mixed Integer Optimization.

Write a Dual Formulation of the Current CPLEX Problem Object

Find a Problem Solution Using the Dual Simplex Algorithm

getConflictExtCPLEX

Get Conflict Status Codes

Access the Total Number of Simplex Iterations to Solve an LP Problem

delTerminateCPLEX

Terminate CPLEX gracefully

getNumColsCPLEX

Access the Number of Columns in the Constraint Matrix

getNumMIPstartsCPLEX

Access the Number of MIP Starts in the CPLEX Problem Object

disconnectChannelCPLEX

Flush all Message Destinations Associated with a Channel

getLogFileCPLEX

Access log file to Which Messages are Written

Accesses Reduced Costs for a Range of Variables of a Linear or Quadratic Program

getLogFileNameCPLEX

Get the name of the current logfile

Access the Number of Dual Super-Basic Variables in the Current Solution

getChgParmCPLEX

Get Parameter Numbers for Parameters Which are Not Set at Their Default Values

getBestObjValCPLEX

Access the Currently Best Known Bound of all the Remaining Open Nodes in a Branch-And-Cut Tree

delIndConstrsCPLEX

Delete a Range of Indicator Constraints

getChannelsCPLEX

Obtain Pointers to the Four Default Channels

Access a Single Constraint Matrix Coefficient

delMIPstartsCPLEX

Delete a Range MIP Starts

Access the Number of Nonzero Elements in the Constraint Matrix

getConflictCPLEX

Return Linear Constraints and Variables Belonging to a Conflict

getObjNameCPLEX

Access the Name of the Objective Row of a CPLEX Problem Object

getInfoStrParmCPLEX

Obtain Default Value of a String Parameter

Access the Direction of Optimization

delSetColsCPLEX

Delete a Set of Columns

Accesses a Range of Columns of the Constraint Matrix

Compute a Minimum-Cost Relaxation

getColNameCPLEX

Access a Range of Column Names

delSetRowsCPLEX

Delete a Set of Rows

getNumQConstrsCPLEX

Return the Number of quadratic constraints.

getProbTypeCPLEX

Access Problem Type

getDblQualCPLEX

Access Double-Valued Information About the Quality of the Current Solution of a Problem

getInfoDblParmCPLEX

Obtain Default, Minimum and Maximum Values of a Parameter of Type Double

getDblParmCPLEX

Obtain the Current Value of a CPLEX Parameter of Type Double

getMIPstartIndexCPLEX

Search for the Index Number of the Specified MIP Start

Access Righthand Side Coefficients for a Range of Constraints

getMIPstartNameCPLEX

Access a Range of Names of MIP Starts

getNumQPnzCPLEX

Return the Number of Nonzeros in the Q Matrix

getProbVarCPLEX

Access the Solution Values for a Range of Problem Variables

getIndConstrCPLEX

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

getColTypeCPLEX

Access Types for a Range of Variables

getParmTypeCPLEX

Obtain the Type of a CPLEX Parameter

getMIPstartsCPLEX

Access a Range of MIP Starts of a CPLEX Problem Object

getIntParmCPLEX

Obtain the Current Value of a CPLEX Parameter of Type CPXINT

getLongParmCPLEX

Obtain Current Value of a Parameter of Type CPXLONG

getLowBndsIdsCPLEX

Retrieve Lower Bounds on Variables

getParmValCPLEX

Values and Names of Parameters Having Non-Default Values

Obtain Solution Algorithm

getNumQuadCPLEX

Return the Number of Variables That Have Quadratic Objective Coefficients

Access Solution Objective Value

getObjOffsetCPLEX

Objective Offset Between the Original Problem and the Presolved Problem.

getQConstrCPLEX

Access a Specified Quadratic Constraint on the Variables of a CPLEX Problem Object.

Access the Quadratic Coefficient in the Matrix Q

Perform Presolve

getParmHierNameCPLEX

Obtain the hierarchy name string of a CPLEX parameter

Create new CPLEX Environment And New CPLEX Problem Object

getStatStrCPLEX

Return an Status Message String Corresponding to an Status Code

Access the Solution Status of the Problem

Access MIP Priority Order Information

refineMIPstartConflictCPLEX

Refine a Conflict in Order to Determine Why a Given MIP Start is Not Feasible

Find a Solution to a Problem Using the Primal Simplex Method

Accesses Righthand Side Coefficients Range Coefficients

getPreStatCPLEX

Access Presolve Status Information for Columns and Rows

refineMIPstartConflictExtCPLEX

Identify a Minimal Conflict

setIntParmCPLEX

Set the Value of a CPLEX Parameter of Type CPXINT

tightenBndsCPLEX

Change the Lower or Upper Bounds on a Set of Variables of a Problem

setLogFileCPLEX

Modifies the log file to which Messages are Written

Access the Sense for a Range of Constraints in a CPLEX Problem Object.

Get a Pointer for the Presolved Problem

getSiftItCntCPLEX

Access Total Number of Sifting Iterations

getVersionCPLEX

Get Version Number of the CPLEX Library.

Solve the Specified Problem by the CPLEX Barrier Optimizer

Access a Range of Columns of the Matrix Q of a Model With a Quadratic Objective Function

getRowIndexCPLEX

Search for the Index Number of a Specified Row

getSiftPase1CntCPLEX

Access Number of Phase I Sifting Iterations

getInfoIntParmCPLEX

Obtain Default, Minimum and Maximum Values of a Parameter of Type CPXINT

getProbNameCPLEX

Access Problem Name

Find a Solution to a Problem Using One of the CPLEX Linear Optimizers

Accesses Slack Values for a Range of Linear Constraints

Tune Parameters of the Environment For Improved Optimizer Performance

getInfoLongParmCPLEX

Obtain Default, Minimum and Maximum Values of a Parameter of Type CPXLONG

getUpperBndsCPLEX

Access a Range of Upper Bounds on Variables

getUppBndsIdsCPLEX

Retrieve Upper Bounds on Variables

getSubStatCPLEX

Access Solution Status of the Last Subproblem Optimization

Add Empty Columns to a Specified CPLEX Problem Object

getRowInfeasCPLEX

Compute Infeasibility of a Given Solution for a Range of Linear Constraints

getMIPrelGapCPLEX

Access Relative Objective Gap for a MIP Optimization

Find a Solution to a Mixed Integer Program

readCopyBaseCPLEX

Read Basis From a BAS File and Copy it Into a CPLEX Problem Object

getLowerBndsCPLEX

Access a Range of Lower Bounds on Variables

getNumRowsCPLEX

Access the Number of Rows in the Constraint Matrix

Get a Time Stamp

Add Empty Constraints to a Specified CPLEX Problem Object

refineConflictCPLEX

Identify a Minimal Conflict for the Infeasibility of the Linear Constraints and the Variable Bounds

refineConflictExtCPLEX

Identify a Minimal Conflict

printTerminateCPLEX

Print Termination Signal

Access Upper and Lower Sensitivity Ranges for Objective Function Coefficients

setStrParmCPLEX

Set the Value of a CPLEX String Parameter

Find a Solution to a Continuous Quadratic Program

Change the Sense of the Optimization for a Problem

Initialize a CPLEX Environment

readCopyOrderCPLEX

readCopyParmCPLEX

Reads Parameter Names And Settings From a File

getParmNameCPLEX

Obtain the Name of a CPLEX Parameter, Given the Symbolic Constant

Access a Range of Objective Function Coefficients of a CPLEX Problem Object

readCopyProbCPLEX

Read an MPS, LP, or SAV File Into an Existing CPLEX Problem Object

readCopyMIPstartsCPLEX

Read a File in the Format MST

status_codeCPLEX

Translates an IBM ILOG CPLEX Status Value into a Human Readable String

readCopySolCPLEX

Reads a Solution From a SOL Format File

setTerminateCPLEX

Release Termination Signal

Access Solution Values Produced by Optimization Routines

Solve a Reduced Model

getParmNumCPLEX

Obtain the Reference Number of a CPLEX Parameter

Write a Solution File

setDefaultParmCPLEX

Reset All CPLEX Parameters And Settings to Default Values

setDblParmCPLEX

Set the Value of a CPLEX Parameter of Type Double

getPhase1CntCPLEX

Access Number of Phase I Iterations

Access Solution Information

Write a CPLEX Problem Object to File

Write Names and Current Settings of CPLEX Parameters to File

Accesses a Range of Rows of the Constraint Matrix

getRowNameCPLEX

Access a Range of Row Names

getStrParmCPLEX

Obtain the Current Value of a CPLEX String Parameter

getSubMethodCPLEX

Accesses Solution Method of the Last Subproblem Optimization

preslvWriteCPLEX

Write a Presolved Version of the Problem to File

Create a CPLEX Problem Object in the CPLEX Environment

Access Dual Values for a Range of Constraints

Use CPLEX Network Optimizer

Write Priority Order to ORD File

setLogFileNameCPLEX

Set and open a log file

setLongParmCPLEX

Set the Value of a Parameter of Type CPXLONG

Access Upper and Lower Sensitivity Ranges for Righthand Side Values of a Range of Constraints

return_codeCPLEX

Translates a IBM ILOG CPLEX Return Code into a Human Readable String

writeMIPstartsCPLEX

Write a Range of MIP Starts to a File in MST Format

unscaleProbCPLEX

Remove Any Scaling Applied to the Resident Problem