Class IloTuple

Definition file: ilopl/ilotuple.h

This class creates a tuple as a line of a tuple set.

This class represents a tuple object that clusters together closely related data.

The data are organized in sets of tuples or arrays of tuples

You should not create IloTuple objects directly, but instead create them using the method IloTupleSet::makeTuple or the class IloTupleIterator.

See Also:

IloTupleSet, IloTupleMap

Method Summary
`public void`	`display(ostream & outs) const`
`public void`	`end()`
`public IloAnyCollection`	`getAnyCollectionValue(const char * col) const`
`public IloAnyCollection`	`getAnyCollectionValue(IloIntArray path) const`
`public IloAnyCollection`	`getAnyCollectionValue(IloInt index) const`
`public IloAny`	`getAnyValue(IloIntArray path) const`
`public IloTupleCollection`	`getCollection() const`
`public IloEnv`	`getEnv() const`
`public IloInt`	`getIndex() const`
`public IloIntCollection`	`getIntCollectionValue(const char * col) const`
`public IloIntCollection`	`getIntCollectionValue(IloIntArray path) const`
`public IloIntCollection`	`getIntCollectionValue(IloInt index) const`
`public IloIntMap`	`getIntMapValue(const char * col) const`
`public IloIntMap`	`getIntMapValue(IloIntArray path) const`
`public IloIntMap`	`getIntMapValue(IloInt index) const`
`public IloIntSet`	`getIntSetValue(const char * col) const`
`public IloIntSet`	`getIntSetValue(IloIntArray path) const`
`public IloIntSet`	`getIntSetValue(IloInt index) const`
`public IloInt`	`getIntValue(const char * col) const`
`public IloInt`	`getIntValue(IloIntArray path) const`
`public IloInt`	`getIntValue(IloInt index) const`
`public IloNumCollection`	`getNumCollectionValue(const char * col) const`
`public IloNumCollection`	`getNumCollectionValue(IloIntArray path) const`
`public IloNumCollection`	`getNumCollectionValue(IloInt index) const`
`public IloNumMap`	`getNumMapValue(const char * col) const`
`public IloNumMap`	`getNumMapValue(IloIntArray path) const`
`public IloNumMap`	`getNumMapValue(IloInt index) const`
`public IloNumSet`	`getNumSetValue(const char * col) const`
`public IloNumSet`	`getNumSetValue(IloIntArray path) const`
`public IloNumSet`	`getNumSetValue(IloInt index) const`
`public IloNum`	`getNumValue(const char * col) const`
`public IloNum`	`getNumValue(IloIntArray path) const`
`public IloNum`	`getNumValue(IloInt index) const`
`public IloTupleSchema`	`getSchema() const`
`public const char *`	`getStringValue(const char * col) const`
`public const char *`	`getStringValue(IloIntArray path) const`
`public const char *`	`getStringValue(IloInt index) const`
`public IloSymbolSet`	`getSymbolSetValue(const char * col) const`
`public IloSymbolSet`	`getSymbolSetValue(IloIntArray path) const`
`public IloSymbolSet`	`getSymbolSetValue(IloInt index) const`
`public IloSymbol`	`getSymbolValue(const char * col) const`
`public IloSymbol`	`getSymbolValue(IloIntArray path) const`
`public IloSymbol`	`getSymbolValue(IloInt index) const`
`public IloTupleBuffer`	`makeTupleBuffer() const`
`public IloTuple`	`makeTupleValue(const char * col) const`
`public IloTuple`	`makeTupleValue(IloIntArray path) const`
`public IloTuple`	`makeTupleValue(IloInt index) const`
`public void`	`setCollection(IloTupleCollection coll)`
`public void`	`setIndex(IloInt i)`

Method Detail

display

public void display(ostream & outs) const

Displays the created tuple.

This member function deletes the invoking object. That is, it frees all the resources used by the invoking object. After a call to this member function, you cannot use the invoking extractable object again.

getAnyCollectionValue

public IloAnyCollection getAnyCollectionValue(const char * col) const

Returns the IloAnyCollection value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

col	The column name of the invoking tuple.

Returns:

An IloAnyCollection representing the value of the column.

getAnyCollectionValue

public IloAnyCollection getAnyCollectionValue(IloIntArray path) const

Returns the IloAnyCollection value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

See Also:

IloTuple::getIntValue

Parameters:

path	The column of the invoking tuple.

Returns:

An IloAnyCollection representing the value of the column.

getAnyCollectionValue

public IloAnyCollection getAnyCollectionValue(IloInt index) const

Returns the IloAnyCollecton value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

index

The column of the invoking tuple.

Returns:

An IloAnyCollection representing the value of the column.

getAnyValue

public IloAny getAnyValue(IloIntArray path) const

Returns the IloAny value of the given column of the invoking tuple. Produces an error if the column type is not compatible.

See Also:

IloTuple::getIntValue

Parameters:

path	The column of the invoking tuple.

Returns:

An IloAny representing the value of the column.

getCollection

public IloTupleCollection getCollection() const

Returns the collection that the index is pointing to.

Returns:

An IloTupleCollection representing the collection.

getEnv

public IloEnv getEnv() const

This member function returns the environment in which the invoking tuple was created.

Returns:

The environment in which the invoking tuple was created.

getIndex

public IloInt getIndex() const

Returns the position of the invoking tuple in its tuple set.

Returns:

An integer representing the position of the invoking tuple.

getIntCollectionValue

public IloIntCollection getIntCollectionValue(const char * col) const

Returns the IloIntCollection value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

col	The column name of the invoking tuple.

Returns:

An IloIntCollection representing the value of the column.

getIntCollectionValue

public IloIntCollection getIntCollectionValue(IloIntArray path) const

Returns the IloIntCollection value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

See Also:

IloTuple::getIntValue

Parameters:

path	The column of the invoking tuple.

Returns:

An IloIntCollection representing the value of the column.

getIntCollectionValue

public IloIntCollection getIntCollectionValue(IloInt index) const

Returns the IloIntCollection value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

The tuple set remains the owner of the collection.

Parameters:

index

The column of the invoking tuple.

Returns:

An IloIntCollection representing the value of the column.

getIntMapValue

public IloIntMap getIntMapValue(const char * col) const

Returns the IloIntMap value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

col	The column name of the invoking tuple.

Returns:

An IloIntMap representing the value of the column.

getIntMapValue

public IloIntMap getIntMapValue(IloIntArray path) const

Returns the IloIntMap value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

See Also:

IloTuple::getIntValue

Parameters:

path	The column of the invoking tuple.

Returns:

An IloIntMap representing the value of the column.

getIntMapValue

public IloIntMap getIntMapValue(IloInt index) const

Returns the IloIntMap value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

index

The column of the invoking tuple.

Returns:

An IloIntMap representing the value of the column.

getIntSetValue

public IloIntSet getIntSetValue(const char * col) const

Returns the IloIntSet value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

col	The column name of the invoking tuple.

Returns:

An IloIntSet representing the value of the column.

getIntSetValue

public IloIntSet getIntSetValue(IloIntArray path) const

Returns the IloIntSet value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

See Also:

IloTuple::getIntValue

Parameters:

path	The column of the invoking tuple.

Returns:

An IloIntSet representing the value of the column.

getIntSetValue

public IloIntSet getIntSetValue(IloInt index) const

Returns the IloIntSet value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

index

The column of the invoking tuple.

Returns:

An IloIntSet representing the value of the column.

getIntValue

public IloInt getIntValue(const char * col) const

Returns the value of the given column of the invoking tuple as an integer. Produces an error if the column type is not compatible.

Parameters:

col	The column name of the invoking tuple.

Returns:

An integer representing the value of the column.

getIntValue

public IloInt getIntValue(IloIntArray path) const

Returns the IloInt value of the given column of the invoking tuple. Produces an error if the column type is not compatible.

For a tuple having this schema:

 < a: int, b: int, c: S1, d: int >

where S1 is

 < e: symbol, f: S2, g: symbol >

and S2 is

 <  h: int, i: float >

getIntValue( [2,2] ) implies return the value of g and getIntValue( [2,1,0] ) implies return the value of h.

Parameters:

path	The column of the invoking tuple.

Returns:

An integer representing the value of the column.

getIntValue

public IloInt getIntValue(IloInt index) const

Returns the integer value of the given column of the invoking tuple and produces an execution error if the column type is not IloInt.

Parameters:

index

The column of the invoking tuple.

Returns:

An int representing the value of the given column.

getNumCollectionValue

public IloNumCollection getNumCollectionValue(const char * col) const

Returns the IloNumCollection value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

col	The column name of the invoking tuple.

Returns:

An IloNumCollection representing the value of the column.

getNumCollectionValue

public IloNumCollection getNumCollectionValue(IloIntArray path) const

Returns the IloNumCollection value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

See Also:

IloTuple::getIntValue

Parameters:

path	The column of the invoking tuple.

Returns:

An IloNumCollection representing the value of the column.

getNumCollectionValue

public IloNumCollection getNumCollectionValue(IloInt index) const

Returns the IloNumCollection value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

index

The column of the invoking tuple.

Returns:

An IloNumCollection representing the value of the column.

getNumMapValue

public IloNumMap getNumMapValue(const char * col) const

Returns the IloNumMap value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

col	The column name of the invoking tuple.

Returns:

An IloNumMap representing the value of the column.

getNumMapValue

public IloNumMap getNumMapValue(IloIntArray path) const

Returns the IloNumMap value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

See Also:

IloTuple::getIntValue

Parameters:

path	The column of the invoking tuple.

Returns:

An IloNumMap representing the value of the column.

getNumMapValue

public IloNumMap getNumMapValue(IloInt index) const

Returns the IloNumMap value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

index

The column of the invoking tuple.

Returns:

An IloNumMap representing the value of the column.

getNumSetValue

public IloNumSet getNumSetValue(const char * col) const

Returns the IloNumSet value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

col	The column name of the invoking tuple.

Returns:

An IloNumSet representing the value of the column.

getNumSetValue

public IloNumSet getNumSetValue(IloIntArray path) const

Returns the IloNumSet value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

See Also:

IloTuple::getIntValue

Parameters:

path	The column of the invoking tuple.

Returns:

An IloNumSet representing the value of the column.

getNumSetValue

public IloNumSet getNumSetValue(IloInt index) const

Returns the IloNumSet value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

index

The column of the invoking tuple.

Returns:

An IloNumSet representing the value of the column.

getNumValue

public IloNum getNumValue(const char * col) const

Returns the value of the given column of the invoking tuple as floating-point number. Produces an error if the column type is not compatible.

Parameters:

col	The column name of the invoking tuple.

Returns:

A float representing the value of the column.

getNumValue

public IloNum getNumValue(IloIntArray path) const

Returns the IloNum value of the given column of the invoking tuple. Produces an error if the column type is not compatible.

See Also:

IloTuple::getIntValue

Parameters:

path	The column of the invoking tuple.

Returns:

A float representing the value of the column.

getNumValue

public IloNum getNumValue(IloInt index) const

Returns the IloNum value of the given column of the invoking tuple and produces an execution error if the column type is not IloNum.

Parameters:

index

The column of the invoking tuple.

Returns:

A float representing the value of the given column.

getSchema

public IloTupleSchema getSchema() const

Returns the schema of the created tuple.

Returns:

An IloTupleSchema containing the schema of the new tuple.

getStringValue

public const char * getStringValue(const char * col) const

Returns the value of the given column of the invoking tuple as a string. Produces an error if the column type is not compatible.

Parameters:

col	The column name of the invoking tuple.

Returns:

A char representing the value of the column.

getStringValue

public const char * getStringValue(IloIntArray path) const

Returns the value of the given column of the invoking tuple as a string. Produces an error if the column type is not compatible.

See Also:

IloTuple::getIntValue

Parameters:

path	The column of the invoking tuple.

Returns:

A char representing the value of the column.

getStringValue

public const char * getStringValue(IloInt index) const

Returns the value of the given column of the invoking tuple as a string. Produces an error if the column type is not compatible.

Parameters:

index

The column of the invoking tuple.

Returns:

A char representing the value of the column.

getSymbolSetValue

public IloSymbolSet getSymbolSetValue(const char * col) const

Returns the IloSymbolSet value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

col	The column name of the invoking tuple.

Returns:

An IloSymbolSet representing the value of the column.

getSymbolSetValue

public IloSymbolSet getSymbolSetValue(IloIntArray path) const

Returns the IloSymbolSet value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

See Also:

IloTuple::getIntValue

Parameters:

path	The column of the invoking tuple.

Returns:

An IloSymbolSet representing the value of the column.

getSymbolSetValue

public IloSymbolSet getSymbolSetValue(IloInt index) const

Returns the IloSymbolSet value of the given column of the invoking tuple. The IloTupleSet remains the owner of the collection. Produces an error if the column type is not compatible.

Parameters:

index

The column of the invoking tuple.

Returns:

An IloSymbolSet representing the value of the column.

getSymbolValue

public IloSymbol getSymbolValue(const char * col) const

Returns the IloSymbol value of the given column of the invoking tuple. Produces an error if the column type is not compatible.

Parameters:

col	The column name of the invoking tuple.

Returns:

An IloSymbol representing the value of the column.

getSymbolValue

public IloSymbol getSymbolValue(IloIntArray path) const

Returns the IloSymbol value of the given column of the invoking tuple. Produces an error if the column type is not compatible.

See Also:

IloTuple::getIntValue

Parameters:

path	The column of the invoking tuple.

Returns:

An IloSymbol representing the value of the column.

getSymbolValue

public IloSymbol getSymbolValue(IloInt index) const

Returns the IloSymbol value of the given column of the invoking tuple. Produces an error if the column type is not compatible.

Parameters:

index

The column of the invoking tuple.

Returns:

An IloSymbol representing the value of the column.

makeTupleBuffer

public IloTupleBuffer makeTupleBuffer() const

Returns a buffer to commit on the IloTupleSet

To populate a set of tuple, you have to commit tuples by values.

See Also:

IloTupleBuffer

Returns:

The IloTupleBuffer to be committed.

makeTupleValue

public IloTuple makeTupleValue(const char * col) const

Creates and returns the IloTuple value of the given column of the invoking tuple.

Parameters:

col	The column of the invoking tuple.

Returns:

An IloTuple representing the value of the column.

makeTupleValue

public IloTuple makeTupleValue(IloIntArray path) const

Creates and returns the IloTuple value of the given column of the invoking tuple.

Parameters:

path	The column of the invoking tuple.

Returns:

An IloTuple representing the value of the column.

makeTupleValue

public IloTuple makeTupleValue(IloInt index) const

Creates and returns the IloTuple value of the given column of the invoking tuple.

Parameters:

index

The column of the invoking tuple.

Returns:

An IloSymbol representing the value of the column.

setCollection

public void setCollection(IloTupleCollection coll)

sets the collection

setIndex

public void setIndex(IloInt i)

Sets the index that points to the collection.

Parameters:

i	The index of the collection.