About This Manual

This reference manual documents the application programming interface (API) of ILOG CPLEX. There are separate reference manuals for the Callable Library, C++, Java, and C#.NET APIs.

Group Summary
optim.cplex.advanced.callable	The API of the advanced C routines of the ILOG CPLEX Callable Library.
optim.cplex.callable	The API of the ILOG CPLEX Callable Library for users of C.
optim.cplex.callable.accesslporqpresults	The routines in the ILOG CPLEX Callable Library to access LP or QP results.
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.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.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.

Group Summary

The API of the advanced C routines of the ILOG CPLEX Callable Library.

optim.cplex.callable

The API of the ILOG CPLEX Callable Library for users of C.

optim.cplex.callable.accesslporqpresults

The routines in the ILOG CPLEX Callable Library to access LP or QP results.

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

What Are the ILOG CPLEX Component Libraries?

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:

the CPLEX Callable Library, a C application programming interface (API), and
ILOG Concert Technology, an object-oriented API for C++, Java, and C#.NET users.

ILOG Concert Technology is also part of ILOG Solver, enabling cooperative strategies using CPLEX and Solver together for solving difficult optimization problems.

What You Need to Know

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. The Concert Technology libraries are written in the C++, Java, and C#.NET programming languages. If you use these products, 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.

Notation and Naming Conventions

Throughout this manual:

The names of routines and parameters defined in the CPLEX Callable Library begin with CPX. The names of classes and functions defined in Concert Technology C++ API begin with Ilo. This convention helps prevent name space conflicts with user-written routines and other code libraries.
The names of Component Library classes, functions, routines, and routine arguments appear in this typeface (examples: CPXprimopt, numcols, IloCplex::solveFixed).