Initializing help system before first use

XPRBnewsos

XPRBnewsos

Purpose
Create a SOS.
Synopsis
XPRBsos XPRBnewsos(XPRBprob prob, const char *name, int type);
Arguments
prob 
Reference to a problem.
name 
The name of the set.
type 
The set type, which must be one of:
XPRB_S1 
Special Ordered Set of type 1;
XPRB_S2 
Special Ordered Set of type 2.
Return value
Reference to the new SOS if function executed successfully, NULL otherwise.
Example
The following creates an SOS of type 1, called sos1. 
XPRBprob prob;
XPRBsos set1;
   ...
set1 = XPRBnewsos(prob, "sos1", XPRB_S1);
Further information
This function creates a Special Ordered Set (SOS) of type 1 or 2 (abbreviated SOS1 and SOS2). It returns the address of the set that is taken as a parameter in the functions for adding set members, such as XPRBaddsosel, deleting single elements XPRBdelsosel or the entire set XPRBdelsos. If the indicated name is already in use, BCL adds an index to it. If no name is given for the set, BCL generates a default name starting with SOS. (The generation of unique names will only take place if the names dictionary is enabled, see XPRBsetdictionarysize.)
Related topics
XPRBdelsos, XPRBgetsosname, XPRBgetsostype, XPRBnewsosrc, XPRBnewsosw, XPRBsetdictionarysize.

Parent Topic BCL C library functions

© 2001-2019 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.