ILNumerics Ultimate VS

SizeGetSeqIndex Method (InArrayInt64)

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Retrieves the element index of an element located at indices stored in an array according to this size descriptor.

[ILNumerics Core Module]

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

public long GetSeqIndex(
	InArray<long> indices
)

Parameters

indices
Type: ILNumericsInArrayInt64
Indices into each dimension of the element to retrieve.

Return Value

Type: Int64
The element index of the addressed item.
Remarks

The value returned corresponds to the number of elements to add to the beginning of the underlying storage array in order to find the requested element. Note that this offset has a unit of 'element'. If the element type is a reference type the array stores its element in 1 dimensional managed arrays and the value returned by GetSeqIndex(InArrayInt64) can directly be used for indexing into this 1d array.

For value typed elements which are stored into unmanaged heaps and where access is done via pointers the address of the element as addressed by indices is computed by p = p0 + GetSeqIndex(indices) * sizeof(T). Here, p0 is the base address (IntPtr, void* or byte*) of the arrays memory as acquired from [!:Array<T>.GetHostPointerForWrite()].

indices may contain negative dimension indices in which case the location of the element is considered at the absolute value

[ILNumerics Core Module]

See Also

Reference