Related Documentation

> Meet ILOG CPLEX > Related Documentation

Related Documentation

The online information files are distributed with the ILOG CPLEX libraries and can be found in yourCplexHome/doc and its subdirectories:

html
pdf
windows

The complete documentation set for ILOG CPLEX consists of the following material:

ILOG CPLEX Getting Started: It is a good idea for new users of ILOG CPLEX to start with that manual. It introduces ILOG CPLEX through the Interactive Optimizer, and contains tutorials for ILOG CPLEX Concert Technology for C++, Java, and C#.NET applications as well as the ILOG CPLEX Callable Library.

The ILOG CPLEX Getting Started manual is supplied in HTML, in Microsoft compiled HTML help (.chm), and as a PDF file.

ILOG CPLEX User's Manual: This manual explains the topics covered in the Getting Started manual in greater depth, with individual chapters about:

LP (Linear Programming) problems;
Network-Flow problems;
QP (Quadratic Programming) problems;
QCP (Quadratically Constrained Programming), and
MIP (Mixed Integer Programming) problems.

There is also detailed information about:

managing input and output,
using query routines,
using callbacks, and
using parallel optimizers.

The ILOG CPLEX User's Manual is supplied in HTML form, in Microsoft compiled HTML help (.chm), and as a PDF file.

ILOG CPLEX Callable Library and C++ API Reference Manual: This manual supplies detailed definitions of the routines, classes, macros, and functions in the ILOG CPLEX Callable Library C and C++ application programming interface (API). It is available online as HTML, as Microsoft compiled HTML help (.chm), and as a PDF file.

As part of that online manual, you can also access other reference material:

Overview of the API offers you navigational links into the HTML reference manual organized into categories of tasks you may want to perform in your applications. Each category includes a table linking to the corresponding C routine, C++ class or method, and Java interface, class, or method to accomplish the task. There are also indications about the name of the corresponding C#.NET method so you can locate it in the Microsoft compiled HTML help (.chm).
ILOG CPLEX Error Codes documents error codes by name in the group optim.cplex.errorcodes. You can also acess error codes by number in the Overview of the API through the link Interpreting Error Codes.
ILOG CPLEX Solution Quality Codes documents solution quality codes by name in the group optim.cplex.solutionquality.
ILOG CPLEX Solution Status Codes documents solution status codes by name in the group optim.cplex.solutionstatus. You can also acess solution status codes by number in the Overview of the API through the link Interpreting Solution Status Codes.

ILOG Concert C++ API Reference Manual: This manual supplements the ILOG CPLEX C++ API Reference Manual with more information about the modeling layer.
ILOG CPLEX Parameters Reference Manual: This manual lists the parameters of ILOG CPLEX with their names in the Callable Library, in Concert Technology, and in the Interactive Optimizer. It also shows their default settings with explanations of the effect of other settings. Normally, the default settings of ILOG CPLEX solve a wide range of mathematical programming problems without intervention on your part, but these parameters are available for fine tuning in special cases.
ILOG CPLEX File Formats Reference Manual: This manual documents the file formats recognized and supported by ILOG CPLEX.
ILOG CPLEX Interactive Optimizer Reference Manual: This manual lists the commands of the Interactive Optimizer, along with their options and links to examples of their use in the ILOG CPLEX User's Manual.
ILOG CPLEX C#.NET Reference Manual: This manual documents the C#.NET API of Concert Technology for ILOG CPLEX. It is available as Microsoft compiled HTML help (.chm).
ILOG CPLEX Java Reference Manual: This manual supplies detailed definitions of the Concert Technology interfaces and ILOG CPLEX Java classes. It is available online as HTML and as Microsoft compiled HTML help (.chm).
ILOG License Manager (ILM): ILOG products are protected by the ILOG License Manager. Before you can use ILOG CPLEX, you need to set up ILM. Its online documentation explains how to do so step-by-step, for different platforms. It is in HTML form, included with your distribution.

PREVIOUS NEXT