ilog.concert

Interface IloNumVarMap

All Superinterfaces:

IloMap

public interface IloNumVarMap
extends IloMap

This is the class for mapping a list of integer variables values. This list is indexed by sets of integers, floats, strings or tuples.

Method Summary

Methods

Modifier and Type	Method and Description
IloNumVar	get(double index) This method returns the element index from the map.
IloNumVar	get(IloTuple index) This method returns the element index from the map.
IloNumVar	get(int index) This method returns the element index from the map.
IloNumVar	get(java.lang.String index) This method returns the element index from the map.
IloNumVar	getAt(IloMapIndexArray indices) This method returns the value of the element.
IloNumVarMap	getSub(double index) This method returns the submap index from the map.
IloNumVarMap	getSub(IloTuple index) This method returns the submap index from the map.
IloNumVarMap	getSub(int index) This method returns the submap index from the map.
IloNumVarMap	getSub(java.lang.String index) This method returns the submap index from the map.
void	set(double index, IloNumVar v) This method sets the element index in the current map to v.
void	set(IloTuple index, IloNumVar v) This method sets the element index in the current map to v.
void	set(int index, IloNumVar v) This method sets the element index in the current map to v.
void	set(java.lang.String index, IloNumVar v) This method sets the element index in the current map to v.
void	setAt(IloMapIndexArray indices, IloNumVar 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

IloNumVarMap 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

IloNumVarMap 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

IloNumVarMap 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

IloNumVarMap 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

IloNumVar 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

IloNumVar 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

IloNumVar 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

IloNumVar 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,
       IloNumVar 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,
       IloNumVar 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,
       IloNumVar 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,
       IloNumVar 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,
         IloNumVar 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

IloNumVar 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