Class IlcIntTupleSet

An integer tuple is an ordered set of integer values. A set of integer tuples is represented by an instance of IlcIntTupleSet. That is, the elements of an integer tuple set are integer tuples. The number of values in a tuple is known as the arity of the tuple, and the arity of the tuples in a set is called the arity of the set. (In contrast, the number of tuples in the set is known as the cardinality of the set.)

As a handle class, IlcIntTupleSet manages certain set operations efficiently. In particular, elements can be added to such a set. It is also possible to search a given set with the member function IlcIntTupleSet::isIn to see whether or not the set contains a given element.

In addition, a set of integer tuples can represent a constraint defined on a constrained integer variable, either as the set of allowed combinations of values of the constrained variable on which the constraint is defined, or as the set of forbidden combinations of values.

There are a few conventions governing integer tuple sets:

• When you create the set, you must specify the arity of the tuple-elements it contains.
• You use the member function IlcIntTupleSet::add to add integer tuples to the set.
• Before searching to determine whether or not an integer tuple belongs to a given set, you must close the set by calling the member function IlcIntTupleSet::close. This operation—-closing the set—-improves the performance of certain other operations on the set.

CP Optimizer will throw an exception (an instance of IloException) if you attempt:

• to add an integer tuple with a different number of variables from the arity of the set;
• to add an element to a set that has already been closed;
• to search for an integer tuple with an arity different from the set arity;
• to search for an integer tuple in a set that has not been closed yet;
• to define a constraint on an integer tuple set that has not been closed already.

You do not have to worry about memory allocation. If you respect these conventions, CP Optimizer manages allocation and de-allocation transparently for you.

This constructor creates a set of integer tuples (an instance of the class IlcIntTupleSet) with the arity indicated by arity.

This member function adds an integer tuple represented by the array tuple to the invoking set. If you attempt to add an element that is already in the set, that element will not be added again; in other words, CP Optimizer respects the definition of a set as containing exclusive elements with no duplicates. Added elements are not copied; that is, there is no memory duplication. CP Optimizer will throw an exception (an instance of IloException) if the set has already been closed. CP Optimizer will throw an exception (an instance of IloException) if the size of the array is not equal to the arity of the invoking set.

This member function closes the invoking set. That is, it states that all the tuples in the set are known so efficient data structures can be defined and exploited.

This member function returns IlcTrue if the invoking set has been closed. Otherwise, it returns IlcFalse.

This member function returns IlcTrue if tuple belongs to the invoking set. Otherwise, it returns IlcFalse. CP Optimizer will throw an exception (an instance of IloException) if the set has not yet been closed. CP Optimizer will throw an exception (an instance of IloException) if the size of the array is not equal to the arity of the invoking set.