Introduction

The Overview of the APIs follows these naming conventions in programming languages.

This overview provides a convenient way to locate information about routines and methods of 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 C#.NET API correspond very closely to those in the Java API with these systematic exceptions:

• In the Java API, the names of classes begin with the prefix Ilo, whereas in C#.NET they do not.

• In the Java API, the names of methods conventionally begin with a lowercase letter, for example, addCols, whereas in the C#.NET API, the names of methods conventionally begin with an uppercase (that is, capital) letter, for example, AddCols according to Microsoft practice.

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.

• Creating and deleting problems

• Optimizing problems

• Accessing results for continuous models

• Accessing results for discrete models

• Generating and keeping a pool of solutions

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.

• Accessing general problem data

• Accessing MIP problem data

• Accessing QP problem data

• Accessing QCP problem data

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.

• Reading files

• Writing files

Modifying problems

Problem modification methods and routines are used to change a problem after it has been created as an IloCplex object.

• Modifying problems

• Using logical constraints

Setting and querying parameters

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

• Setting parameters

• Recognizing parameters that differ

CPLEX utilities

The following methods and functions provide additional capabilities.

• General utilities

• Using messages

• Using callbacks