ExtensionMethodsGetValue Method (BaseArraycomplex, UInt32, UInt32, UInt32, UInt32)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Retrieves the value of the element at the position specified by d0 ... d3.

[ILNumerics Core Module]

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

Syntax

public static complex GetValue(
	this BaseArray<complex> A,
	uint d0,
	uint d1,
	uint d2,
	uint d3
)

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

Dim A As BaseArray(Of complex)
Dim d0 As UInteger
Dim d1 As UInteger
Dim d2 As UInteger
Dim d3 As UInteger
Dim returnValue As complex

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

Parameters

A: Type: ILNumericsBaseArraycomplex
The array instance.
d0: Type: SystemUInt32
Index into the first dimension.
d1: Type: SystemUInt32
Index into the second dimension.
d2: Type: SystemUInt32
Index into the third dimension.
d3: Type: SystemUInt32
Index into the fourth dimension or sequential index into remaining dimensions of the array.

Return Value

Type: complex
Element value.

Usage Note

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

SizeGetSeqIndex(UInt32)

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

ArrayTGetHostPointerForWrite(NullableStorageOrders)