CPXXparamsetgetids and CPXparamsetgetids

The routine CPXXparamsetgetids/CPXparamsetgetids returns an array of parameter numbers (unique identifiers) for parameters which are in the paramset.

int CPXXparamsetgetids( CPXCENVptr env, CPXCPARAMSETptr ps, int * cnt_p, int * whichparams, int pspace, int * surplus_p)

int CPXparamsetgetids( CPXCENVptr env, CPXCPARAMSETptr ps, int * cnt_p, int * whichparams, int pspace, int * surplus_p)

Description

The routine CPXXparamsetgetids/CPXparamsetgetids returns an array of parameter numbers (unique identifiers) for parameters which are in the paramset.

Note:

The parameter numbers are returned in an unspecified order.

The CPLEX Parameters Reference Manual provides a list of parameters with their types, options, and default values.

Arguments

env: A pointer to the CPLEX environment as returned by CPXXopenCPLEX/CPXopenCPLEX.
ps: A pointer to the CPLEX parameter set as returned by CPXXparamsetcreate/CPXparamsetcreate using env as the environment.
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 whichparams, provided the funtion returns 0 (zero). If the function returns CPXERR_NEGATIVE_SURPLUS then *cnt_p is unchanged.
whichparams: The array to hold the parameter IDs of the parameters in the parameter set.
pspace: An integer specifying the length of the array whichparams.
surplus_p: A pointer to an integer to contain the difference between pspace and the number of entries in whichparams. A nonnegative value of surplus_p specifies 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 routine returns the value CPXERR_NEGATIVE_SURPLUS, and the value of *surplus_p specifies the amount of insufficiency (that is, how much more space is needed in the array).

Return

The routine returns 0 (zero) if successful and nonzero if an error occurs.

Example


        status = CPXparamsetgetids (env, ps, cnt_p, whichparams, pspace, surplus_p);

See also Parameter sets and Examples for multiobjective optimization in the CPLEX User's Manual.