ilog.concert

Interface IloSymbolMap

All Superinterfaces:

IloMap

public interface IloSymbolMap
extends IloMap

The class IloSymbolMap maps a list of string elements. This list is indexed by sets of integers, floats, strings or tuples.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	get(double index) This method returns the element index from the map.
java.lang.String	get(IloTuple index) This method returns the element index from the map.
java.lang.String	get(int index) This method returns the element index from the map.
java.lang.String	get(java.lang.String index) This method returns the element index from the map.
java.lang.String	getAt(IloMapIndexArray indices) This method returns the value of the element.
IloSymbolMap	getSub(double index) This method returns the submap index from the map.
IloSymbolMap	getSub(IloTuple index) This method returns the submap index from the map.
IloSymbolMap	getSub(int index) This method returns the submap index from the map.
IloSymbolMap	getSub(java.lang.String index) This method returns the submap index from the map.
void	set(double index, java.lang.String v) This method sets the element index in the current map to v.
void	set(IloTuple index, java.lang.String v) This method sets the element index in the current map to v.
void	set(int index, java.lang.String v) This method sets the element index in the current map to v.
void	set(java.lang.String index, java.lang.String v) This method sets the element index in the current map to v.
void	setAt(IloMapIndexArray indices, java.lang.String v) This method sets the value of the element to v.

Methods inherited from interface ilog.concert.IloMap

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

Method Detail

getSub

IloSymbolMap getSub(int index)
                    throws IloException

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

Throws:

IloException

getSub

IloSymbolMap getSub(double index)
                    throws IloException

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

Throws:

IloException

getSub

IloSymbolMap getSub(java.lang.String index)
                    throws IloException

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

Throws:

IloException

getSub

IloSymbolMap getSub(IloTuple index)
                    throws IloException

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

Throws:

IloException

get

java.lang.String get(int index)
                     throws IloException

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

Throws:

IloException

get

java.lang.String get(double index)
                     throws IloException

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

Throws:

IloException

get

java.lang.String get(java.lang.String index)
                     throws IloException

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

Throws:

IloException

get

java.lang.String get(IloTuple index)
                     throws IloException

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

Throws:

IloException

set

void set(int index,
       java.lang.String v)
         throws IloException

This method sets the element index in the current map to v. The invoking map should be of only one dimension.

Throws:

IloException

set

void set(double index,
       java.lang.String v)
         throws IloException

This method sets the element index in the current map to v. The invoking map should be of only one dimension.

Throws:

IloException

set

void set(java.lang.String index,
       java.lang.String v)
         throws IloException

This method sets the element index in the current map to v. The invoking map should be of only one dimension.

Throws:

IloException

set

void set(IloTuple index,
       java.lang.String v)
         throws IloException

This method sets the element index in the current map to v. The invoking map should be of only one dimension.

Throws:

IloException

setAt

void setAt(IloMapIndexArray indices,
         java.lang.String v)
           throws IloException

This method sets the value of the element to v. The values in indices must be the accessors you would use with getSub and getAt methods.

Throws:

IloException

getAt

java.lang.String getAt(IloMapIndexArray indices)
                       throws IloException

This method returns the value of the element. Example with a map of int: M[i in 1..5][j in 1..2] = j M.getAt( [1][2] ) will return M[1][2] that is 2. It is the same as using M.getSub(1).get(2).

Throws:

IloException