CPXgetmipstart

Usage

Description

The routine CPXgetmipstart() is used to access MIP start information stored in an LP problem object. Values are returned for all integer, binary, and nonzero SOS variables when the MIP start is the result of a call to CPXmipopt().

Return Value

The routine returns a zero on success, and a nonzero if an error occurs. The value CPXERR_NEGATIVE_SURPLUS indicates that insufficient space was available in the indices and values arrays to hold the MIP start information.

Synopsis

int CPXgetmipstart (CPXENVptr env,
                    CPXLPptr lp,
                    int *cnt_p,
                    int *indices,
                    double *values,
                    int startspace,
                    int *surplus_p);

Arguments


CPXENVptr env

The pointer to the CPLEX environment as returned by one of the CPXopenCPLEX routines.

CPXLPptr lp

A pointer to a CPLEX LP problem object as returned by CPXcreateprob().

int *cnt_p

A pointer to an integer that will contain the number of MIP start entries returned; i.e., the true length of the arrays indices, and values.

int *indices

An array where the indices of the variables in the MIP start are to be returned. indices[k] will be the index of the variable which is entry k in the MIP start information. indices must be of length no less than startspace.

double *values

An array where the MIP start values are to be returned. The start value corresponding to indices[k] is returned in values[k]. values must be of length at least startspace.

int startspace

An integer indicating the length of the non-NULL array indices, and values. startspace may be 0.

int *surplus_p

A pointer to an integer that will contain the difference between startspace and the number of entries in each of the arrays indices, and values. A non-negative value of *surplus_p indicates that the length of the arrays was sufficient. A negative value indicates that the length was insufficient and that the routine could not complete its task. In this case, the routine CPXgetmipstart() returns the value CPXERR_NEGATIVE_SURPLUS, and the negative value of *surplus_p indicates the amount of insufficient space in the arrays.

If the value of startspace is 0, then the negative of the value of *surplus_p returned indicates the length needed for the arrays indices and values.

Example

status = CPXgetmipstart (env, lp, &listsize, indices, values,
                         numcols, &surplus);