Introducing the API Overview

This Overview provides a convenient way to locate information about routines and methods of ILOG CPLEX, categorized by purpose. Information about the C, C++, and Java APIs appears in the tables of this overview. Names of classes, methods, and symbolic constants in the .NET API correspond very closely to those in the Java API with these systematic exceptions:

Optimization and Results

Optimization and result methods and routines are used to define an active problem, optimize that problem, and report the results of the optimization.

Querying Problems

Problem query methods and routines are used to access information about a problem object after it has been created as an IloCplex object. They can be used at any time, even after problem modifications.

Reading from and Writing to Files

File reading methods and routines are used to read problems from system files. File writing methods and routines are used to write a problem object, an optimal basis, or a solution report to a file.

Setting and Querying Parameters

Parameter setting and querying methods and functions are used to control the behavior of the algorithms within CPLEX.

Interpreting Codes

CPLEX returns additional information about the status of a solution as a symbolic constant or code number. It also returns error messages as symbolic constants or code numbers.

CPLEX Utilities

The following methods and functions provide additional capabilities.