Initializing help system before first use

XPRBnewsum

Purpose
Create a sum constraint.
Synopsis
XPRBctr XPRBnewsum(XPRBprob prob, const char *name, XPRBarrvar av, int type, double rhs);
Arguments
prob 
Reference to a problem.
name 
The constraint name (of unlimited length). May be NULL if not required.
av 
Reference to an array of variables.
type 
Type of the constraint, which must be one of:
XPRB_L 
`less than or equal to' constraint;
XPRB_G 
'greater than or equal to' constraint;
XPRB_E 
equality;
XPRB_N 
a non-binding row (objective function).
rhs 
Right hand side value of the constraint.
Return value
Reference to the new constraint if function executed successfully, NULL otherwise.
Example
The following creates a new constraint, ctr2, given by ∑i=04 ty1i = 9. 
XPRBprob prob;
XPRBctr ctr2;
XPRBarrvar ty1;
   ...
ty1 = XPRBnewarrvar(prob, 5, XPRB_PL, "arry1", 0, 500);
ctr2 = XPRBnewsum(prob, "r2", ty1, XPRB_E, 9);
Further information
This function creates a simple sum constraint over all entries of an array of variables. It replaces calls to XPRBnewctr and XPRBaddterm. If the indicated name is already in use, BCL adds an index to it. If no constraint name is given, BCL generates a default name starting with CTR. (The generation of unique names will only take place if the names dictionary is enabled, see XPRBsetdictionarysize.)
Note:
all terms that are added to a constraint must belong to the same problem as the constraint itself.
Related topics
XPRBnewarrsum, XPRBnewctr, XPRBnewprec, XPRBsetdictionarysize.

Parent Topic BCL C library functions

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.