CPXXgetchgparam and CPXgetchgparam
The routine CPXXgetchgparam/CPXgetchgparam returns an array of
parameter numbers (unique identifiers) for parameters which are
not set at their default values.
int CPXXgetchgparam( CPXCENVptr env, int * cnt_p, int * paramnum, int pspace, int * surplus_p )
int CPXgetchgparam( CPXCENVptr env, int * cnt_p, int * paramnum, int pspace, int * surplus_p )
Description
The routine CPXXgetchgparam/CPXgetchgparam returns an array of
parameter numbers (unique identifiers) for parameters which are
not set at their default values.
Arguments
- env
-
A pointer to the CPLEX environment, as returned by
CPXXopenCPLEX/CPXopenCPLEX. - cnt_p
-
A pointer to an integer to contain the number of parameter
numbers (unique identifiers) returned, that is, the true length
of the array
paramnum. If the function returns either 0 (zero) orCPXERR_NEGATIVE_SURPLUS, then this value contains the number of elements that were stored inparanum. Otherwise, the value is either unchanged or set to 0 (zero). - paramnum
- The array to contain the numbers of the parameters with nondefault values.
- pspace
-
An integer specifying the length of the array
paramnum. - surplus_p
-
A pointer to an integer to contain the difference between
pspaceand the number of entries inparamnum. A nonnegative value ofsurplus_pspecifies that the length of the arrays was sufficient. A negative value specifies that the length was insufficient and that the routine could not complete its task. In that case, the routineCPXXgetchgparam/CPXgetchgparamreturns the valueCPXERR_NEGATIVE_SURPLUS, and the value ofsurplus_pspecifies the amount of insufficiency (that is, how much more space is needed in the arrays).
Return
The routine returns 0 (zero) if successful and nonzero if an error occurs. The value CPXERR_NEGATIVE_SURPLUS specifies that
insufficient space was available in the array paramnum
to hold the parameter numbers (unique identifiers) with nondefault values.