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

167

Version

1.4.0

License

GPL-3 | file LICENSE

Maintainer

Last Published

September 21st, 2020

Functions in cplexAPI (1.4.0)

baseWriteCPLEX

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

Adds Columns to a Specified CPLEX Problem Object
baroptCPLEX

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

Add Quadratic Constraint to a Specified CPLEX Problem Object
boundSaCPLEX

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

Adds an Indicator Constraint to the Specified CPLEX Problem Object
addFpDestCPLEX

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

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
cLpWriteCPLEX

Write an LP Format File Containing Identified Conflict
chgColTypeCPLEX

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

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

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

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
chgNameCPLEX

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
chgSenseCPLEX

Change Sense of a Set of Linear Constraints
copyQPsepCPLEX

Copy the Quadratic Objective Matrix Q for a Separable QP Problem
chgObjCPLEX

Change Linear Objective Coefficients
copyOrderCPLEX

Copy Priority Order to CPLEX Problem Object
checkAddRowsCPLEX

Validate Arguments of the Corresponding addRowsCPLEX Routine
chgProbTypeCPLEX

Change the Current Problem to a Related Problem
cloneProbCPLEX

Copy a CPLEX Problem Object
checkChgCoefListCPLEX

Validate Arguments of the Corresponding chgCoefListCPLEX Routine
chgQPcoefCPLEX

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

Free all of the Data Structures Associated With CPLEX
chgColsBndsCPLEX

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

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
copyLpCPLEX

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

Copy Variable Type Information Into a Given Problem
closeFileCPLEX

Close a File
chgRngValCPLEX

Change Range Coefficients
chgRhsCPLEX

Change Righthand Side Coefficients
cplexAPI-package

R Interface to C API of IBM ILOG CPLEX
cplexConstants

Constants, Parameters, Return and Status Codes of IBM ILOG CPLEX
cplexPtr-class

Class "cplexPtr"
delRowsCPLEX

Delete a Range of Rows
closeProbCPLEX

Close CPLEX Environment And Remove CPLEX Problem Object
cplexError-class

Class "cplexError"
delQConstrsCPLEX

Delete a Range of Quadratic Constraints
delColsCPLEX

Delete all Columns in a Specified Range
delNamesCPLEX

Remove all Names Assigned to Rows and Columns
delProbCPLEX

Remove Specified CPLEX Problem Object
delFpDestCPLEX

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

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
copyStartCPLEX

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
getGradCPLEX

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

Access Basis Resident in a CPLEX Problem Object.
getIntQualCPLEX

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

Access MIP Cutoff Value Being Used During Mixed Integer Optimization.
dualWriteCPLEX

Write a Dual Formulation of the Current CPLEX Problem Object
dualoptCPLEX

Find a Problem Solution Using the Dual Simplex Algorithm
getConflictExtCPLEX

Get Conflict Status Codes
getItCntCPLEX

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
getDjCPLEX

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

Get the name of the current logfile
getDbsCntCPLEX

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
getCoefCPLEX

Access a Single Constraint Matrix Coefficient
delMIPstartsCPLEX

Delete a Range MIP Starts
getNumNnzCPLEX

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
getObjDirCPLEX

Access the Direction of Optimization
delSetColsCPLEX

Delete a Set of Columns
getColsCPLEX

Accesses a Range of Columns of the Constraint Matrix
feasOptCPLEX

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
fileputCPLEX

Write to File
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
getRhsCPLEX

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
getMethodCPLEX

Obtain Solution Algorithm
getNumQuadCPLEX

Return the Number of Variables That Have Quadratic Objective Coefficients
getObjValCPLEX

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

Access the Quadratic Coefficient in the Matrix Q
presolveCPLEX

Perform Presolve
getParmHierNameCPLEX

Obtain the hierarchy name string of a CPLEX parameter
openProbCPLEX

Create new CPLEX Environment And New CPLEX Problem Object
getStatStrCPLEX

Return an Status Message String Corresponding to an Status Code
getStatCPLEX

Access the Solution Status of the Problem
openFileCPLEX

Open a File
getOrderCPLEX

Access MIP Priority Order Information
refineMIPstartConflictCPLEX

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

Find a Solution to a Problem Using the Primal Simplex Method
getRngValCPLEX

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
getSenseCPLEX

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

Get a Pointer for the Presolved Problem
getSiftItCntCPLEX

Access Total Number of Sifting Iterations
getVersionCPLEX

Get Version Number of the CPLEX Library.
hybbaroptCPLEX

Solve the Specified Problem by the CPLEX Barrier Optimizer
getQuadCPLEX

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
lpoptCPLEX

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

Accesses Slack Values for a Range of Linear Constraints
tuneParmCPLEX

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
newColsCPLEX

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
mipoptCPLEX

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
getTimeCPLEX

Get a Time Stamp
newRowsCPLEX

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
objSaCPLEX

Access Upper and Lower Sensitivity Ranges for Objective Function Coefficients
setStrParmCPLEX

Set the Value of a CPLEX String Parameter
qpoptCPLEX

Find a Solution to a Continuous Quadratic Program
setObjDirCPLEX

Change the Sense of the Optimization for a Problem
openEnvCPLEX

Initialize a CPLEX Environment
readCopyOrderCPLEX

Read ORD File
readCopyParmCPLEX

Reads Parameter Names And Settings From a File
getParmNameCPLEX

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

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
solutionCPLEX

Access Solution Values Produced by Optimization Routines
siftoptCPLEX

Solve a Reduced Model
getParmNumCPLEX

Obtain the Reference Number of a CPLEX Parameter
solWriteCPLEX

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
solnInfoCPLEX

Access Solution Information
writeProbCPLEX

Write a CPLEX Problem Object to File
writeParmCPLEX

Write Names and Current Settings of CPLEX Parameters to File
getRowsCPLEX

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
initProbCPLEX

Create a CPLEX Problem Object in the CPLEX Environment
getPiCPLEX

Access Dual Values for a Range of Constraints
hybnetoptCPLEX

Use CPLEX Network Optimizer
ordWriteCPLEX

Write Priority Order to ORD File
setLogFileNameCPLEX

Set and open a log file
setLongParmCPLEX

Set the Value of a Parameter of Type CPXLONG
rhsSaCPLEX

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