Function scip_sys::SCIPgetConsVars

source ·
pub unsafe extern "C" fn SCIPgetConsVars(
    scip: *mut SCIP,
    cons: *mut SCIP_CONS,
    vars: *mut *mut SCIP_VAR,
    varssize: c_int,
    success: *mut c_uint
) -> SCIP_RETCODE
Expand description

method to collect the variables of a constraint

If the number of variables is greater than the available slots in the variable array, nothing happens except that the success point is set to FALSE. With the method SCIPgetConsNVars() it is possible to get the number of variables a constraint has in its scope.

@return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref SCIP_Retcode “SCIP_RETCODE” for a complete list of error codes.

@pre This method can be called if @p scip is in one of the following stages: - \ref SCIP_STAGE_PROBLEM - \ref SCIP_STAGE_TRANSFORMING - \ref SCIP_STAGE_TRANSFORMED - \ref SCIP_STAGE_INITPRESOLVE - \ref SCIP_STAGE_PRESOLVING - \ref SCIP_STAGE_EXITPRESOLVE - \ref SCIP_STAGE_PRESOLVED - \ref SCIP_STAGE_INITSOLVE - \ref SCIP_STAGE_SOLVING - \ref SCIP_STAGE_SOLVED - \ref SCIP_STAGE_EXITSOLVE - \ref SCIP_STAGE_FREETRANS

@note The success pointer indicates if all variables were copied into the vars arrray.

@note It might be that a constraint handler does not support this functionality, in that case the success pointer is set to FALSE.