Documentation

GRBgetgenconstrMin


GRBgetgenconstrMin

int GRBgetgenconstrMin ( GRBmodel *model,
    int id,
    int* resvarP,
    int* nvarsP,
    int* vars,
    double* constantP )

Retrieve the data of a general constraint of type MIN. Calling this function for a general constraint of different type leads to an error return code. You can query the GenConstrType attribute to determine the type of the general constraint.

Typical usage is to call this routine twice. In the first call, you specify the requested general constraint, with a NULL value for the vars argument. The routine returns the total number of operand variables in the specified general constraint in nvarsP. That allows you to make certain that the vars array is of sufficient size to hold the result of the second call.

See also GRBaddgenconstrMin for a description of the semantics of this general constraint type.

Return value:

A non-zero return value indicates that a problem occurred while retrieving the data of the general constraint. Refer to the Error Code table for a list of possible return values. Details on the error can be obtained by calling GRBgeterrormsg.

Arguments:

model: The model to which the new general constraint should be added.

id: The index of the general constraint to retrieve.

Note that any combination of the following arguments can be NULL.

int *resvarP: The variable index associated with the resultant variable of the constraint.

int *nvarsP: The number of operand variables of the constraint.

int *vars: An array to store the variable indices associated with the variable operands of the constraint.

double *constantP: The additional constant operand of the constraint.

Example usage:

  int type;
  int resvar;
  int nvars;
  int *vars;
  double constant;

  error = GRBgetintattrelement(model, GRB_INT_ATTR_GENCONSTRTYPE, 3, &type);
  if (type == GRB_GENCONSTR_MIN) {
    error = GRBgetgenconstrMin(model, 3, &resvar, &nvars, NULL, &constant);
    /* ...allocate vars to hold 'nvars' values... */
    error = GRBgetgenconstrMin(model, 3, NULL, NULL, vars, NULL);
  }