CPLEX Callable Library (C API) Reference Manual

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

What are the CPLEX Component Libraries?

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

The CPLEX Component Libraries consist of:

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

Concert Technology is also part of CP Optimizer, enabling cooperative strategies using CPLEX and CP Optimizer 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 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.

Notation and naming conventions

Throughout this manual, the names of routines and parameters defined in the CPLEX Callable Library begin with CPXX (for the 64-bit API) and CPX (for the 32-bit API). This convention helps prevent name-space conflicts with user-written routines and other code libraries.

The names of Component Library routines and arguments of routines appear in this typeface (examples: CPXprimopt, numcols).