XPRMArray Class
An array in Mosel.
Inheritance Hierarchy
Namespace: Mosel
Assembly: xprmdn (in xprmdn.dll) Version: 4.8.3.0
Syntax
C#
public class XPRMArray : XPRMValue
The XPRMArray type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 |
Dim |
Array dimensions; number indices required to access an array cell
|
|
FirstIndex |
Index of the first cell of the array.
|
|
FirstTEIndex |
Index of the first defined cell of the array. Dynamic arrays do not necessarily have a defined cell for each index.
|
|
IndexSets |
Sets indexing the array. When indices are given to the array in other functions, we use indexes into the index sets - ie if there are two index sets {2,3,4} and {"a", "b", "c"), then the array position [2,"c"] will be passed to
Get(Int32) as an array of two integers: [1,3], because "2" is the first element of the first index set, and "c" is the third element of the second index set.
|
|
Indices |
A list containing all the index positions in the array - each index position is given as an int[].
|
|
IsDynamic |
Check whether the array is dynamic.
|
|
IsEmpty |
Check whether the array is empty.
|
|
IsInitialised |
Check whether the array has been initialised. Objects are initialised during model execution. Trying to access a Mosel object that has not been created will result on an exception.
(Overrides XPRMValueIsInitialised.) |
|
LastIndex |
Index of the last cell of the array.
|
|
Model |
Used to fetch the XPRM model to which this object belongs, or else 'null' if there is no model anywhere among this Object's ancestors.
(Inherited from XPRMObjectBase.) |
|
Owner |
Used to fetch the XPRM object to which this object belongs
(Inherited from XPRMObjectBase.) |
|
Size |
The total number of elements in the array
|
|
StructCode | (Inherited from XPRMTypedObject.) |
|
StructName | (Inherited from XPRMTypedObject.) |
|
TEIndices |
A list containing the index positions of all the defined cells in the array - each index position is given as an int[].
|
|
Type | (Inherited from XPRMTypedObject.) |
|
TypeCode | (Inherited from XPRMTypedObject.) |
|
TypeName | (Inherited from XPRMTypedObject.) |
Methods
| Name | Description | |
|---|---|---|
 |
AsArray |
An array type value. This function is defined if the actual object is of a array type.
(Overrides XPRMValueAsArray.) |
|
AsBoolean |
A Boolean. This function is defined if the actual object is a Boolean
(Inherited from XPRMValue.) |
|
AsExternal |
An external type value. This function is defined if the actual object is of an external type.
(Inherited from XPRMValue.) |
|
AsInteger |
An integer. This function is defined if the actual object is an integer.
(Inherited from XPRMValue.) |
|
AsLinCtr |
A linear constraint. This function is defined if the actual object is a linear constraint.
(Inherited from XPRMValue.) |
|
AsList |
A list type value. This function is defined if the actual object is of a list type.
(Inherited from XPRMValue.) |
|
AsMPVar |
A decision variable. This function is defined if the actual object is a decision variable.
(Inherited from XPRMValue.) |
|
AsProblem |
A problem. This function is defined if the actual object is a problem.
(Inherited from XPRMValue.) |
|
AsReal |
A real. This function is defined if the actual object is a real.
(Inherited from XPRMValue.) |
|
AsRecord |
A record type value. This function is defined if the actual object is of a record type.
(Inherited from XPRMValue.) |
|
AsSet |
A set type value. This function is defined if the actual object is of a set type.
(Inherited from XPRMValue.) |
|
AsString |
A string. This function is defined if the actual object is a string.
(Inherited from XPRMValue.) |
|
DereferenceIndex |
Given an array index as the offsets into the index sets, this function returns the corresponding values from the index sets.
|
|
Equals | (Overrides ObjectEquals(Object).) |
 |
Finalize |
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.) |
|
Get(Int32) |
Get the cell content associated to the given index (1 dim. array).
|
|
Get(Int32) |
Get the cell content associated to the given index.
|
 |
Get(Int32, Int32) |
Get the cell content associated to the given index.
|
|
GetAsBoolean(Int32) |
Get the cell content associated to the given index (1 dim. array of booleans).
|
|
GetAsBoolean(Int32) |
Get the cell content associated to the given index (array of booleans)
|
|
GetAsBoolean(Int32, Int32) |
Get the cell content associated to the given index (array of booleans)
|
|
GetAsInteger(Int32) |
Get the cell content associated to the given index (1 dim. array of integers).
|
|
GetAsInteger(Int32) |
Get the cell content associated to the given index (array of integers)
|
|
GetAsInteger(Int32, Int32) |
Get the cell content associated to the given index (array of integers)
|
|
GetAsReal(Int32) |
Get the cell content associated to the given index (1 dim. array of reals).
|
|
GetAsReal(Int32) |
Get the cell content associated to the given index (array of reals)
|
|
GetAsReal(Int32, Int32) |
Get the cell content associated to the given index (array of reals)
|
|
GetAsString(Int32) |
Get the cell content associated to the given index (1 dim. array of strings).
|
|
GetAsString(Int32) |
Get the cell content associated to the given index (array of strings)
|
|
GetAsString(Int32, Int32) |
Get the cell content associated to the given index (array of strings)
|
|
GetHashCode | (Overrides ObjectGetHashCode.) |
|
GetType |
Gets the type of the current instance.
(Inherited from Object.) |
|
GetValue |
Given a list of values (comprising objects of type int, string, bool or double), returns the value at the array index indicated by the value. Note: it is not recommended you call this function within intense loops, as it performs poorly due to the need to look up each index value in each index set for every call.
|
|
GetValueAsBoolean |
Given a list of values (comprising objects of type int, string, bool or double), returns the boolean value at the array index indicated by the value. Note: it is not recommended you call this function within intense loops, as it performs poorly due to the need to look up each index value in each index set for every call.
|
|
GetValueAsInteger |
Given a list of values (comprising objects of type int, string, bool or double), returns the integer value at the array index indicated by the value. Note: it is not recommended you call this function within intense loops, as it performs poorly due to the need to look up each index value in each index set for every call.
|
|
GetValueAsReal |
Given a list of values (comprising objects of type int, string, bool or double), returns the floating point value at the array index indicated by the value. Note: it is not recommended you call this function within intense loops, as it performs poorly due to the need to look up each index value in each index set for every call.
|
|
GetValueAsString |
Given a list of values (comprising objects of type int, string, bool or double), returns the string value at the array index indicated by the value. Note: it is not recommended you call this function within intense loops, as it performs poorly due to the need to look up each index value in each index set for every call.
|
|
IndexToString |
Given an array index, this formats the index by each of the index sets
|
|
LookupIndexValues(Object) |
Given a list of values of the array index (comprising objects of type int, string, bool or double), returns the index set positions for each value.
|
|
LookupIndexValues(XPRMValue) |
Given an array of XPRMValue[] objects, produce the array index as the offsets into the index sets of this array.
|
|
MemberwiseClone |
Creates a shallow copy of the current
Object.
(Inherited from Object.) |
|
NextIndex |
Updates the given index to point to the next defined cell in the array.
|
|
NextTEIndex |
Updates the given index to point to the next cell in the array.
|
|
ToString |
Generate a string representation of the cells of the array.
(Overrides XPRMTypedObjectToString.) |
See Also
Reference
© 2001-2019 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.