Class IloIntSetVar

Definition file: ilconcert/iloset.h

The class IloIntSetVar.

An instance of this class represents a set of integer values. The same integer value will not appear more than once in a set. The elements of a set are not ordered.

A constrained variable representing a set of integer values (that is, an instance of IloIntSetVar) is defined in terms of two other sets: its required elements and its possible elements. Its required elements are those that must be in the set. Its possible elements are those that may be in the set. This class offers member functions for accessing the required and possible elements of a set of integer values.

The function IloCard offers you a way to constrain the number of elements in a set variable. That is, IloCard constrains the cardinality of a set variable.

Constructor Summary
`public`	`IloIntSetVar()`
`public`	`IloIntSetVar(IloIntSetVar::ImplClass *)`
`public`	`IloIntSetVar(const IloEnv, const IloIntArray, const char *)`
`public`	`IloIntSetVar(const IloEnv, const IloIntArray, const IloIntArray, const char *)`
`public`	`IloIntSetVar(const IloEnv, const IloNumArray, const char *)`
`public`	`IloIntSetVar(const IloEnv, const IloNumArray, const IloNumArray, const char *)`

Method Summary
`public void`	`addPossible(IloInt)`
`public void`	`addRequired(IloInt)`
`public IloIntSetVar::ImplClass *`	`getImpl()`
`public void`	`getPossibleSet(IloIntSet)`
`public IloIntSet`	`getPossibleSet()`
`public void`	`getRequiredSet(IloIntSet)`
`public IloIntSet`	`getRequiredSet()`
`public void`	`removePossible(IloInt)`
`public void`	`removeRequired(IloInt)`

Inherited Methods from `IloExtractable`
`end, getEnv, getId, getImpl, getName, getObject, setName, setObject`

Constructor Detail

IloIntSetVar

public IloIntSetVar()

This constructor creates an empty handle. You must initialize it before you use it.

IloIntSetVar

public IloIntSetVar(IloIntSetVar::ImplClass * impl)

This constructor creates a handle object from a pointer to an implementation object.

IloIntSetVar

public IloIntSetVar(const IloEnv env, const IloIntArray array, const char * name)

This constructor creates a constrained set variable and makes it part of the environment env, where the set consists of integer values. By default, its name is indicated by the empty string, but you can indicate a name of your choice.

IloIntSetVar

public IloIntSetVar(const IloEnv env, const IloIntArray possible, const IloIntArray required, const char * name)

This constructor creates a constrained set variable and makes it part of the environment env, where the set consists of integer values. The array possible indicates the set of possible elements of the set variable; the array required specifies the set of required elements of the set variable. By default, its name is indicated by the empty string, but you can indicate a name of your choice.

IloIntSetVar

public IloIntSetVar(const IloEnv env, const IloNumArray array, const char * name)

IloIntSetVar

public IloIntSetVar(const IloEnv env, const IloNumArray possible, const IloNumArray required, const char * name)

This constructor creates a constrained set variable and makes it part of the environment env, where the set consists of integer values. The numeric array possible indicates the set of possible elements of the set variable; the numeric array required specifies the set of required elements of the set variable. By default, its name is indicated by the empty string, but you can indicate a name of your choice.

Method Detail

addPossible

public void addPossible(IloInt elt)

This member function adds elt to the set of possible elements of the invoking set variable.

Note

The member function addPossible notifies Concert Technology algorithms about this change of this invoking object.

addRequired

public void addRequired(IloInt elt)

This member function adds elt to the set of required elements of the invoking set variable.

Note

The member function addRequired notifies Concert Technology algorithms about this change of this invoking object.

getImpl

public IloIntSetVar::ImplClass * getImpl()

This member function returns a pointer to the implementation object of the invoking handle.

getPossibleSet

public void getPossibleSet(IloIntSet set)

This member function accesses the possible elements of the invoking set variable and puts those elements into its parameter set.

getPossibleSet

public IloIntSet getPossibleSet()

This member function returns the possible elements of the invoking set variable.

getRequiredSet

public void getRequiredSet(IloIntSet set)

This member function accesses the possible elements of the invoking set variable and puts those elements into its parameter set.

getRequiredSet

public IloIntSet getRequiredSet()

This member function returns the required elements of the invoking set variable.

removePossible

public void removePossible(IloInt elt)

This member function removes elt as a possible element of the invoking set variable.

Note

The member function removePossible notifies Concert Technology algorithms about this change of this invoking object.

removeRequired

public void removeRequired(IloInt elt)

This member function removes elt as a required element of the invoking set variable.

Note

The member function removeRequired notifies Concert Technology algorithms about this change of this invoking object.