ExtensionMethodsIndexIteratorT Method

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Efficient iterator over generic (but numeric!) type elements for use in 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 IEnumerable<long> IndexIterator<T>(
	this BaseArray<T> A,
	long lastDimIdx,
	Nullable<StorageOrders> order = null
)

<ExtensionAttribute>
Public Shared Function IndexIterator(Of T) ( 
	A As BaseArray(Of T),
	lastDimIdx As Long,
	Optional order As Nullable(Of StorageOrders) = Nothing
) As IEnumerable(Of Long)

Dim A As BaseArray(Of T)
Dim lastDimIdx As Long
Dim order As Nullable(Of StorageOrders)
Dim returnValue As IEnumerable(Of Long)

returnValue = A.IndexIterator(lastDimIdx, 
	order)

Parameters

A: Type: ILNumericsBaseArrayT
The array instance.
lastDimIdx: Type: SystemInt64
The value of the highest index addressable by this iterator. This is used to handle negative indices.
order (Optional): Type: SystemNullableStorageOrders
[Optional] Determines the order the elements are walked along. Default: null (DefaultStorageOrder)

Type Parameters

T: Element type. Expected to be numeric.

Return Value

Type: IEnumerableInt64
Slim, self destructing iterator instance, iterating over all elements of this array and converting values to long indices.

Usage Note

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

Remarks

[ILNumerics Core Module]

Reference

ExtensionMethods Class