Class IloAnyCollectionMap

Definition file: ilopl/ilomap.h

This is the class for mapping a list of IloAnyCollection values.

The class IloAnyCollectionMap is used to map IloAnyCollection elements. This list is indexed by sets of integers, floats, strings or tuples.

Method Summary
`public void`	`endElements()`
`public const IloAnyCollection`	`get(IloTuple index) const`
`public const IloAnyCollection`	`get(IloSymbol index) const`
`public const IloAnyCollection`	`get(const char * index) const`
`public const IloAnyCollection`	`get(IloNum index) const`
`public const IloAnyCollection`	`get(IloInt index) const`
`public IloAnyCollection`	`getAt(IloMapIndexArray indices) const`
`public IloAnyCollectionMap`	`getSub(const char * index) const`
`public IloAnyCollectionMap`	`getSub(IloTuple index) const`
`public IloAnyCollectionMap`	`getSub(IloInt index) const`
`public IloAnyCollectionMap`	`getSub(IloNum index) const`
`public IloAnyCollectionMap`	`operator[](IloTuple index) const`
`public IloAnyCollectionMap`	`operator[](IloSymbol index) const`
`public IloAnyCollectionMap`	`operator[](const char * index) const`
`public IloAnyCollectionMap`	`operator[](IloNum index) const`
`public IloAnyCollectionMap`	`operator[](IloInt index) const`

Method Detail

endElements

public void endElements()

This method ends the invoking map along with all its elements.

get

public const IloAnyCollection get(IloTuple index) const

This member function returns the element index from the map. The invoking map should be of one dimension only.

Parameters:

index

The requested element.

get

public const IloAnyCollection get(IloSymbol index) const

This member function returns the element idx from the map. The invoking map should be of one dimension only. See get(IloInt).

get

public const IloAnyCollection get(const char * index) const

This member function returns the element index from the map. The invoking map should be of one dimension only.

Parameters:

index

The requested element.

get

public const IloAnyCollection get(IloNum index) const

This member function returns the element index from the map. The invoking map should be of one dimension only.

Parameters:

index

The requested element.

get

public const IloAnyCollection get(IloInt index) const

This member function returns the element index from the map. The invoking map should be of one dimension only.

Parameters:

index

The requested element.

getAt

public IloAnyCollection getAt(IloMapIndexArray indices) const

This member function returns the element corresponding to indices from the map. The invoking map should have as many dimensions as the size of indices.

Parameters:

indices

The requested element.

getSub

public IloAnyCollectionMap getSub(const char * index) const

This member function returns the submap index from the map. The invoking map should have more than one dimension.

getSub

public IloAnyCollectionMap getSub(IloTuple index) const

This member function returns the submap index from the map. The invoking map should have more than one dimension.

see IloMap#getSub(IloInt)