The ICumulFunctionExprMap type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
|
Get(Double) |
This member function returns the element index from the map. The invoking map should be of one
dimension only. See Get(Int32).
|
|
|
Get(Int32) |
This member function returns the element index from the map. The invoking map should be of one
dimension only. Example with a Map of int: M[i in 1..5][j in 1..2] = j M.GetSub(1).Get(2)
will return 2
|
|
|
Get(String) |
This member function returns the element index from the map. The invoking map should be of one dimension
only. See Get(Int32).
|
|
|
Get(ITuple) |
This member function returns the element index from the map. The invoking map should be of one dimension
only. See Get(Int32).
|
|
|
GetAt |
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) .
|
|
|
GetSub(Double) |
Returns the submap index from the map. The invoking map should have more than one dimension.
The index is of a numerical type. GetSub(Int32)
|
|
|
GetSub(Int32) |
Returns the submap index from the map. The invoking map should have more than one dimension.
The index is of an integer type. Example with a Map of int: M[i in 1..5][j in 1..2] = iM.getSub( 1 )
returns [1,1]
|
|
|
GetSub(String) |
Returns the submap index from the map. The invoking map should have more than one dimension.
The index is of a string type. GetSub(Int32)
|
|
|
GetSub(ITuple) |
This member function returns the submap index from the map. The invoking map should have more than
one dimension.IMap.GetSub(Int32)
|
|
|
MakeMapIndexer |
Retrieves the indices of an array. (Inherited from IMap.) |
|
|
Set(Double, ICumulFunctionExpr) |
Sets the element index from the map to the value v. The invoking map should be of only one dimension.
See Set(Int32).
|
|
|
Set(Int32, ICumulFunctionExpr) |
Sets the element index from the map to the value v. The invoking map should be of only one dimension.
Example with a Map of int: M[i in 1..5][j in 1..2] = j M.GetSub(1).Set(2, 4) will set M[1][2]
to 4 instead of 2.
|
|
|
Set(String, ICumulFunctionExpr) |
Sets the element index from the map to v. The invoking map should be of only one dimension.
See Set(Int32).
|
|
|
Set(ITuple, ICumulFunctionExpr) |
Sets the element index from the map to v. The invoking map should be of only one dimension.
Set(Int32, ICumulFunctionExpr)
|
|
|
SetAt |
Sets the value of the element. The values in indices must be the accessors you would use
with GetSub and GetAt methods.
Example with a Map of int: M[i in 1..5][j in 1..2] = j M.SetAt( [1][2], 4) will set M[1][2] to 4 instead of 2. It is the same as using M.GetSub(1).set(2, 4) . |
Properties
| Name | Description | |
|---|---|---|
|
|
Name |
Returns the name of the map. (Inherited from IMap.) |
|
|
NbDim |
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.
(Inherited from IMap.) |
|
|
Size |
This member function 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 ).GetSize( ) returns 2.
(Inherited from IMap.) |
|
|
TotalSize |
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).GetTotalSize
returns 2. (Inherited from IMap.) |