ilog.concert

Interface IloTupleMap

All Superinterfaces:

IloMap

public interface IloTupleMap
extends IloMap

This class represents a convenient way to map tuple values.

Method Summary

Methods

Modifier and Type	Method and Description
void	getAt(IloMapIndexArray indexes, IloTuple tuple) Returns the value of the element pointed to by indexes from the map.
ilog.concert.IloDiscreteDataCollection	getIndexer() Returns the data collection that indexes the map.
IloTupleSchema	getSchema() Returns the schema of the tuples that are in the current map.
IloTuple	makeTuple() Creates an empty tuple to be filled by getAt
void	setAt(IloMapIndexArray indexes, IloTuple v) Sets the element pointed to by indexes from the map to v.

Methods inherited from interface ilog.concert.IloMap

getName, getNbDim, getNonEmptySlotSize, getSize, getTotalSize, makeMapIndexer, setName

Method Detail

getAt

void getAt(IloMapIndexArray indexes,
         IloTuple tuple)
           throws IloException

Returns the value of the element pointed to by indexes from the map. It fills the given tuple. Example with a map: M[i in 1..5][j in 1..2] = M.getAt( [1][2], t ) will fill t with M[1][2] that is <2>.

Throws:

IloException

makeTuple

IloTuple makeTuple()
                   throws IloException

Creates an empty tuple to be filled by getAt

Throws:

IloException

setAt

void setAt(IloMapIndexArray indexes,
         IloTuple v)
           throws IloException

Sets the element pointed to by indexes from the map to v. Example with a map: M[i in 1..5][j in 1..2] = M.setAt( [1][2], t ) will fill M[1][2] with the values from t.

Throws:

IloException

getSchema

IloTupleSchema getSchema()

Returns the schema of the tuples that are in the current map.

getIndexer

ilog.concert.IloDiscreteDataCollection getIndexer()

Returns the data collection that indexes the map.