Group | Index | Concepts |
This reference manual documents the Callable Library, the C application programming interface (API) of ILOG CPLEX. There are separate reference manuals for the C++, Java, and .NET APIs of CPLEX. Following this table that summarizes the groups in this manual, you will find more information:
Group Summary | |
---|---|
optim.cplex.callable | The API of the ILOG CPLEX Callable Library for users of C. |
optim.cplex.callable.accessmipresults | The routines in the ILOG CPLEX Callable Library to access MIP results. |
optim.cplex.callable.accessnetworkresults | The routines in the ILOG CPLEX Callable Library to access network results. |
optim.cplex.callable.accessqcpresults | The routines in the ILOG CPLEX Callable Library to access QCP or SOCP results. |
optim.cplex.callable.accessresults | The routines in the ILOG CPLEX Callable Library to access results. |
optim.cplex.callable.advanced | The API of the advanced C routines of the ILOG CPLEX Callable Library. |
optim.cplex.callable.advanced.callbacks | The API of the advanced C callback routines of the ILOG CPLEX Callable Library. |
optim.cplex.callable.analyzesolution | The routines in the ILOG CPLEX Callable Library to analyze solutions. |
optim.cplex.callable.callbacks | The ILOG CPLEX Callable Library routines for managing callbacks. |
optim.cplex.callable.createdeletecopy | The routines in the ILOG CPLEX Callable Library to create and delete problems and to copy data. |
optim.cplex.callable.debug | The ILOG CPLEX Callable Library routines for debugging data. |
optim.cplex.callable.manageparameters | The routines in the ILOG CPLEX Callable Library to manage parameters (that is, set parameters, get current values of parameters, and get information about parameters). |
optim.cplex.callable.message | The ILOG CPLEX Callable Library routines for managing messages. |
optim.cplex.callable.modifynetwork | The routines in the ILOG CPLEX Callable Library to modify a network. |
optim.cplex.callable.modifyproblem |
The routines in the ILOG CPLEX Callable Library to modify a problem created by CPXcreateprob .
|
optim.cplex.callable.network | The network routines in the ILOG CPLEX Callable Library. |
optim.cplex.callable.optimizers | The routines in the ILOG CPLEX Callable Library to launch an optimizer. |
optim.cplex.callable.portability | The portability routines in the ILOG CPLEX Callable Library. |
optim.cplex.callable.querygeneralproblem | The routines in the ILOG CPLEX Callable Library to query general problem data. |
optim.cplex.callable.querymip | The routines in the ILOG CPLEX Callable Library to query MIP problem data. |
optim.cplex.callable.querynetwork | The routines in the ILOG CPLEX Callable Library to query network problem data. |
optim.cplex.callable.queryqcp | The routines in the ILOG CPLEX Callable Library to query QCP problem data (that is, problems with one or more quadratic constraints), including the special case of second order cone programming (SOCP) problems. |
optim.cplex.callable.queryqp | The routines in the ILOG CPLEX Callable Library to query QP problem data (that is, problems with a quadratic objective function). |
optim.cplex.callable.readfiles | The routines in the ILOG CPLEX Callable Library to read files. |
optim.cplex.callable.readnetworkfiles | The routines in the ILOG CPLEX Callable Library to read network files. |
optim.cplex.callable.util | The general utilities in the ILOG CPLEX Callable Library. |
optim.cplex.callable.writefiles | The routines in the ILOG CPLEX Callable Library to write files. |
optim.cplex.callable.writenetworkfiles | The routines in the ILOG CPLEX Callable Library to write network files. |
optim.cplex.errorcodes | The Callable Library macros that define error codes, their symbolic constants, their short message strings, and their explanations. There is a key to the symbols in the short message strings after the table. |
optim.cplex.solutionquality | The Callable Library macros that indicate the qualities of a solution, their symbolic constants, and their meaning. Methods for accessing solution quality are mentioned after the table. |
optim.cplex.solutionstatus | The Callable Library macros that define solution status, their symbolic constants, their equivalent in Concert Technology enumerations, and their meaning. There is a note about unboundedness after the table. |
The ILOG CPLEX Component Libraries are designed to facilitate the development of applications to solve, modify, and interpret the results of linear, mixed integer, continuous convex quadratic, quadratically constrained, and mixed integer quadratic or quadratically constrained programming.
The ILOG CPLEX Component Libraries consist of:
ILOG Concert Technology is also part of ILOG Solver, enabling cooperative strategies using CPLEX and Solver together for solving difficult optimization problems.
This manual assumes that you are familiar with the operating system on which you are using ILOG CPLEX.
The CPLEX Callable Library is written in the C programming language. If you use this product, this manual assumes you can write code in the appropriate language, and that you have a working knowledge of a supported integrated development environment (IDE) for that language.
Throughout this manual:
CPX
.
This convention helps prevent name space conflicts with
user-written routines and other code libraries.this typeface
(examples: CPXprimopt
, numcols
)
In addition to this Reference Manual documenting the Callable Library (C API), ILOG CPLEX also comes with these resources:
readme.html
is delivered in the standard distribution.
This file contains the most current information about platform
prerequisites for ILOG CPLEX.All of the manuals and Release Notes are available in online versions. The online documentation, in HTML format, can be accessed through standard HTML browsers.