ExtensionMethodsGetValue Method (BaseArrayBaseArray, Int64, Int64, Int64)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Retrieves a clone of the value at the position specified by d0 ... d2 as an array. Supports deep indexing.

[ILNumerics Core Module]

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

Syntax

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

<ExtensionAttribute>
Public Shared Function GetValue ( 
	A As BaseArray(Of BaseArray),
	d0 As Long,
	d1 As Long,
	d2 As Long
) As BaseArray

Dim A As BaseArray(Of BaseArray)
Dim d0 As Long
Dim d1 As Long
Dim d2 As Long
Dim returnValue As BaseArray

returnValue = A.GetValue(d0, d1, d2)

Parameters

A: Type: ILNumericsBaseArrayBaseArray
The cell instance.
d0: Type: SystemInt64
Index into the first dimension.
d1: Type: SystemInt64
Index into the second dimension.
d2: Type: SystemInt64
Index into the third 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).

Exceptions

Exception	Condition
IndexOutOfRangeException	if the value of d0 exceeds the number of elements in the first dimension, or the value of d1 exceeds the number of elements in the 2nd dimension, or the computed index according to all index parameters d0, d1,... exceeds the NumberOfElements of A.

Remarks

This functions retrieves the value of the element as given by d0...d2. 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...d2. 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]

Reference

ExtensionMethods Class

GetValue Overload

ILNumerics Namespace

ExtensionMethodsIsTypeOfCellT(ConcreteArrayBaseArray, Cell, InCell, OutCell, RetCell, CellStorage, Int64)

ExtensionMethods.ToRetArray``1(BaseArray)

ExtensionMethodsGetValueT(BaseArrayBaseArray, Int64, Int64)

SizeGetSeqIndex(UInt32)

ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageTGetHostPointerForRead(NullableStorageOrders)

ExtensionMethodsAddLanguageSpecificTextSet("LST1073AFA9_0?cpp=::|nu=.");GetValue Method (BaseArrayAddLanguageSpecificTextSet("LST1073AFA9_1?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");BaseArrayAddLanguageSpecificTextSet("LST1073AFA9_2?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)");, Int64, Int64, Int64)

Parameters

Return Value

Usage Note

Reference

ExtensionMethodsGetValue Method (BaseArrayBaseArray, Int64, Int64, Int64)