Parameter names

Names of CPLEX parameters follow the coding conventions of each API.

In the parameter table, each parameter has a name (that is, a symbolic constant) to refer to it within an application.

  • For the Callable Library (C API), these constants start with CPXPARAM_; for example, CPXPARAM_Simplex_Limits_Iterations. They are used as the second argument in all parameter routines (except CPXXsetdefaults, which does not require them).

    Legacy names

    For the C API, these constants are capitalized and start with CPX_PARAM_; for example, CPX_PARAM_ITLIM. They are used as the second argument in all parameter routines (except CPXsetdefaults, which does not require them).

  • For C++ applications, the parameters are defined in classes that specify a hierarchy of applicability of the parameter; for example, IloCplex::Param::Simplex::Limits::Iterations.

    Legacy names

    For C++ applications, the parameters are defined in nested enumeration types for Boolean, integer, floating-point, and string parameters. The enum names use mixed (lower and upper) case letters and must be prefixed with the class name IloCplex:: for scope. For example, IloCplex::ItLim is the IloCplex equivalent of CPX_PARAM_ITLIM.

  • For Java applications, the parameters are defined as final static objects in nested classes that specify a hierarchy of applicability of the parameter; for example, IloCplex.Param.Simplex.Limits.Iterations.

    Legacy names

    For Java applications, the parameters are defined as final static objects in nested classes called IloCplex.BooleanParam, IloCplex.IntParam, IloCplex.LongParam, IloCplex.DoubleParam, and IloCplex.StringParam for Boolean, integer, long, floating-point, and string parameters, respectively. The parameter object names use mixed (lower and upper) case letters and must be prefixed with the appropriate class for scope. For example, IloCplex.IntParam.ItLim is the object representing the parameter CPX_PARAM_ITLIM.

  • For .NET applications, the parameters follow the usual conventions for capitalizing attributes and defining scope within a namespace.

  • For Python applications, the names of parameters resemble the names in the CPLEX Interactive Optimizer, modified for the syntax of a Python application. For example, the command in the Interactive Optimizer set mip cuts mcfcut looks like this in a Python application:cplex.parameters.mip.cuts.set(mcfcut).

The reference page of each parameter documents an integer that serves as a reference number or unique identifier for each parameter. That integer reference number corresponds to the value that each symbolic constant represents, as found in the cplex.h , cplexx.h , and cpxconst.h header files of the Callable Library (C API).