ExtensionMethodsitemT1 Method (BaseArrayT1, Int64, Int64, Int64, Int64, Int64)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Returns a single element from this array according to the provided dimension indices.

[ILNumerics numpy Module]

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

Syntax

public static T1 item<T1>(
	this BaseArray<T1> A,
	long d0,
	long d1,
	long d2,
	long d3,
	long d4
)

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

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

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

Parameters

A: Type: ILNumericsBaseArrayT1
The ILNumerics n-dim array.
d0: Type: SystemInt64
Index into dimension #0.
d1: Type: SystemInt64
Index into dimension #1.
d2: Type: SystemInt64
Index into dimension #2.
d3: Type: SystemInt64
Index into dimension #3.
d4: Type: SystemInt64
Index into dimension #4.

Type Parameters

T1: Element type.

Return Value

Type: T1
Copy of the element as located by the index arguments d0...d4.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type BaseArrayT1. 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 an index exceeds the allowed range of the corresponding dimension.

Remarks

An index for dimension i can be negative and must evaluate to an element position in the range 0...A.S[i]-1.

This function does not support the merging of trailing, unspecified dimensions as known from [!:ILNumerics.ExtensionMethods.GetValue(BaseArray<bool>, long, long, long, long, long, long, long)] or from itemT1(BaseArrayT1, Int64).

Unspecified dimension indices are assumed to be 0. Optional indices for virtual dimensions must be 0.

[ILNumerics numpy Module]

Reference

ExtensionMethods Class

item Overload

ILNumerics Namespace

ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageTGetItem(Int64)

[!:ILNumerics.ExtensionMethods.GetValue(BaseArray<bool>, long, long, long, long, long, long, long)]