ExtensionMethodsGetValue Method (BaseArrayInt64, 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. Int64 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 long GetValue(
	this BaseArray<long> A,
	long d0,
	long d1,
	long d2,
	long d3,
	long d4
)

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

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

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

Parameters

A: Type: ILNumericsBaseArrayInt64
The array 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.
d3: Type: SystemInt64
Index into the fourth dimension.
d4: Type: SystemInt64
Index into the fifths dimension or sequential index into remaining dimensions of the array.

Return Value

Type: Int64
Element value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type BaseArrayInt64. 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 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.

Remarks

This functions retrieves the value of the element as given by the indices into the first five dimensions.

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.

[ILNumerics Core Module]

Reference

ExtensionMethods Class

GetValue Overload

ILNumerics Namespace

ExtensionMethodsGetValue(BaseArrayInt64, UInt32)

SizeGetSeqIndex(UInt32)

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

ArrayTGetHostPointerForWrite(NullableStorageOrders)