ilog.concert

Interface IloMap

All Known Subinterfaces:

IloConstraintMap, IloCumulFunctionExprMap, IloIntervalSequenceVarMap, IloIntervalVarMap, IloIntMap, IloIntSetMap, IloIntVarMap, IloNumMap, IloNumSetMap, IloNumVarMap, IloPiecewiseFunctionExprMap, IloStateFunctionExprMap, IloSymbolMap, IloSymbolSetMap, IloTupleMap, IloTupleSetMap

public interface IloMap

The superinterface for all maps, allowing to query the size, etc.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() This method returns the name of the map.
int	getNbDim() This method returns the dimension of the map i.e the number of indexers.
int	getNonEmptySlotSize()
int	getSize() This method returns an integer specifying the size of the invoking array.
int	getTotalSize() This method returns the total number of values that are in this array.
ilog.concert.IloDiscreteDataCollectionArray	makeMapIndexer() Retrieves the indices of an array.
void	setName(java.lang.String name) This method sets the name of the map to name.

Method Detail

getNbDim

int getNbDim()

This method returns the dimension of the map i.e the number of indexers. Example with a map of int: M[1..5][1..2] M.getNbDim( ) returns 2.

getSize

int getSize()

This method returns an integer specifying the size of the invoking array. An empty array has size 0 (zero). Example with a map of int: M[1..5][1..2] M.getSize( ) returns 5. M.getSub( 1 ).IloMap.getSize( ) returns 2.

getTotalSize

int getTotalSize()

This method returns the total number of values that are in this array. Example with a map of int: M[1..5][1..2] M.getTotalSize( ) returns 10. M.getSub(1).IloMap.getTotalSize( ) returns 2.

getNonEmptySlotSize

int getNonEmptySlotSize()

getName

java.lang.String getName()

This method returns the name of the map.

setName

void setName(java.lang.String name)

This method sets the name of the map to name.

makeMapIndexer

ilog.concert.IloDiscreteDataCollectionArray makeMapIndexer()

Retrieves the indices of an array.