Class IloAnySet

Definition file: ilconcert/iloanyset.h

A class whose instances represent a set of enumeration values.

An instance of this class represents a set of enumerated values. The same enumerated value will not appear more than once in a set. The elements of a set are not ordered. The class IloAnySet::Iterator offers you a way to traverse the elements of such a set.

If you are considering modeling issues where you want to represent repeated elements or where you want to exploit an indexed order among the elements, then you might want to look at the class IloAnyArray instead of this class for sets.

Most member functions in this class contain assert statements. For an explanation of the macro NDEBUG (a way to turn on or turn off these assert statements), see the concept Assert and NDEBUG.

Constructor Summary
`public`	`IloAnySet(const IloEnv, const IloAnyArray)`
`public`	`IloAnySet(const IloEnv)`

Method Summary
`public void`	`add(IloAnySet)`
`public void`	`add(IloAny)`
`public IloBool`	`contains(IloAnySet)`
`public IloBool`	`contains(IloAny)`
`public IloAnySet`	`copy()`
`public void`	`empty()`
`public void`	`end()`
`public IloEnv`	`getEnv()`
`public IloInt`	`getSize()`
`public IloBool`	`intersects(IloAnySet)`
`public void`	`remove(IloAnySet)`
`public void`	`remove(IloAny)`
`public void`	`setIntersection(IloAnySet)`
`public void`	`setIntersection(IloAny)`

Inner Class
IloAnySet::Iterator	An iterator to traverse the elements of `IloAnySet`.

IloAnySet

public IloAnySet(const IloEnv env, const IloAnyArray array)

This constructor creates a set of enumerated values for env from the elements in array.

IloAnySet

public IloAnySet(const IloEnv env)

This constructor creates an empty set (no elements) for env. You must use the member function IloAnySet::add to fill this set with elements.

Method Detail

add

public void add(IloAnySet set)

This member function adds set to the invoking set. By adds, we mean that the invoking set becomes the union of its former elements and the elements of set.

add

public void add(IloAny elt)

This member function adds elt to the invoking set. By adds, we mean that the invoking set becomes the union of its former elements and the new elt.

contains

public IloBool contains(IloAnySet set)

This member function returns a Boolean value (zero or one) that indicates whether set intersects the invoking set. The value one indicates that the invoking set contains all the elements of set, and that the intersection of the invoking set with set is precisely set. The value zero indicates that the intersection of the invoking set set is not precisely set.

contains

public IloBool contains(IloAny elt)

This member function returns a Boolean value (zero or one) that indicates whether elt is an element of the invoking set. The value one indicates that the invoking set contains elt; the value zero indicates that the invoking set does not contain elt.

copy

public IloAnySet copy()

This member functions creates a clone of the array.

empty

public void empty()

This member function removes the elements from the invoking set. In other words, the invoking set becomes the empty set.

end

public void end()

This member functions reclaims memory associated with the invoking set.

getEnv

public IloEnv getEnv()

This member function returns the environment of the invoking set.

getSize

public IloInt getSize()

This member function returns an integer indicating the size of the invoking set (that is, how many elements it contains).

intersects

public IloBool intersects(IloAnySet set)

This member function returns a Boolean value (zero or one) that indicates whether set intersects the invoking set. The value one indicates that the intersection of set and the invoking set is not empty (at least one element in common); the value zero indicates that the intersection of set and the invoking set is empty (no elements in common).