Documentation


GRBaddgenconstrPoly

int GRBaddgenconstrPoly ( GRBmodel *model,
    const char *name,
    int xvar,
    int yvar,
    int plen,
    double *p,
    const char *options )

Add a new general constraint of type GRB_GENCONSTR_POLY to a model. Note that, due to our lazy update approach, the new constraint won't actually be added until you update the model (using GRBupdatemodel), optimize the model (using GRBoptimize), or write the model to disk (using GRBwrite).

A polynomial function constraint states that the relationship <span>$</span>y = p_0 x^d + p_1 x^{d-1} + ... + p_{d-1} x + p_{d}<span>$</span> should hold between variables <span>$</span>x<span>$</span> and <span>$</span>y<span>$</span>.

A piecewise-linear approximation of the function is added to the model. The details of the approximation are controlled using the following four attributes (or using the parameters with the same names): FuncPieces, FuncPieceError, FuncPiecesLength, and FuncPieceRatio. For details, consult the General Constraint discussion.

Return value:

A non-zero return value indicates that a problem occurred while adding 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.

name: Name for the new general constraint. This argument can be NULL, in which case the constraint is given a default name.

xvar: The index of variable <span>$</span>x<span>$</span>.

yvar: The index of variable <span>$</span>y<span>$</span>.

plen: The length of coefficient array p. If <span>$</span>x^d<span>$</span> is the highest power term, then plen should be <span>$</span>d+1<span>$</span>.

p: The coefficients for the polynomial function (starting with the coefficient for the highest power).

options: A string that can be used to set the attributes that control the piecewise-linear approximation of this function constraint. To assign a value to an attribute, follow the attribute name with an equal sign and the desired value (with no spaces). Assignments for different attributes should be separated by spaces (e.g. "FuncPieces=-1 FuncPieceError=0.001").

Example usage:

  /* y = 3 x^4 + 7 x + 3 = 3 x^4 + 0 x^3 + 0 x^2 + 7 x + 3 */
  int plen = 5;
  double p[] = {3, 0, 0, 7, 3};
  error = GRBaddgenconstrPoly(model, "poly", xvar, yvar, 5, p, "");