ILNumerics Ultimate VS

ExtensionMethodsGetValue Method (BaseArrayBaseArray, Int64, Int64, Int64, Int64, Int64)

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Retrieves the value of the element at the position specified by d0 ... d4 as an array. Supports deep indexing.

[ILNumerics Core Module]

Namespace:  ILNumerics
Assembly:  ILNumerics.Core (in ILNumerics.Core.dll) Version: (5.5.7503.3146)

public static BaseArray GetValue(
	this BaseArray<BaseArray> A,
	long d0,
	long d1,
	long d2,
	long d3,
	long d4


Type: ILNumericsBaseArrayBaseArray
The cell instance.
Type: SystemInt64
Index #0.
Type: SystemInt64
Index #1.
Type: SystemInt64
Index #2.
Type: SystemInt64
Index #3.
Type: SystemInt64
Index #4 into the last dimension or sequential index into remaining dimensions of the array.

Return Value

Type: BaseArray
Copy/clone of the elements value. Scalar values are wrapped into a scalar array.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type BaseArrayBaseArray. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

IndexOutOfRangeExceptionif at least one of the values of d0, d1, d2, d3 exceeds the number of elements in its corresponding dimension, or if the computed index according to all index parameters d0, d1,... exceeds the NumberOfElements of A.

This functions retrieves the value of the element as given by d0...d4. If while searching for the element a cell is found the function steps down into the cell and continues to retrieve the value from the inner cell using subsequent trailing indices left over (deep indexing).

If the value provided by the last index parameter exceeds the number of elements in its corresponding dimension the superflous index value is translated into subsequent dimensions of this inner most array element.

The type of the array returned corresponds to the type of the element addressed by d0...d3. Use GetValueT(BaseArrayBaseArray, Int64) in order to retrieve the element as its natural type. IsTypeOfCellT(ConcreteArrayBaseArray, Cell, InCell, OutCell, RetCell, CellStorage, Int64) can be used to inspect the element type.

[ILNumerics Core Module]

See Also