MIP integer solution-file switch and prefix

MIP integer solution file switch and filename prefix.

Purpose

MIP integer solution-file switch and filename prefix.

API Parameter Name Name prior to V12.6.0
C CPXPARAM_Output_IntSolFilePrefix CPX_PARAM_INTSOLFILEPREFIX
C++ IloCplex::Param::Output::IntSolFilePrefix IntSolFilePrefix (string)
OPL not available
Interactive output intsolfileprefix output intsolfileprefix
Identifier 2143 2143

Description

Decides whether CPLEX writes the current MIP incumbent integer solution to a file and (if so) sets a prefix for the name of that file.

By default, the value of this parameter is the empty string, and file-writing is turned off. When this parameter is set to a non empty string, CPLEX writes each new incumbent to a file at the time the MIP integer solution is found.

In addition to switching on the writing of a file of solutions, this parameter also specifies the prefix of the name of the file to use. The prefix can contain a relative or absolute path. If the prefix does not contain a relative or absolute path, CPLEX writes to a file in the directory for working files.

The complete file name of the file that CPLEX writes is PREFIX-NNNNN.sol, where:

  • PREFIX is the prefix specified by this parameter;

  • NNNNN is the sequence number of the solution; the sequence starts at 00001;

  • sol represents the solution file format, documented in the topic SOL file format: solution files in the reference manual, File formats supported by CPLEX.

Note:

Existing files of the same name will be overwritten.

If the specified file cannot be written (for example, in case of lack of disk space, or no write access to the specified location), optimization stops with an error status code.

This parameter accepts a string as its value. If you change either the API string encoding switch or the file encoding switch from their default value to a multi-byte encoding where a NULL byte can occur within the encoding of a character, you must take into account the issues documented in the topic Selecting an encoding in the CPLEX User's Manual. Especially consider the possibility that a NULL byte occurring in the encoding of a character can inadvertently signal the termination of a string, such as a filename or directory path, and thus provoke surprising or incorrect results.

Values

valid string for the prefix of a file name; default: ” “ (the empty string; that is, the switch is off)

See also

directory for working files