ILNumerics Ultimate VS

ExtensionMethodsGetBaseArray Method

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development

Note: This API is now obsolete.

Retrieves a clone of the value at the position d0 as an array.

[ILNumerics Core Module]

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

[ObsoleteAttribute("Use A.GetValue(d0) on cell array A instead!")]
public static BaseArray GetBaseArray(
	this BaseArray<BaseArray> A,
	long d0


Type: ILNumericsBaseArrayBaseArray
The cell instance.
Type: SystemInt64
Index into the first dimension or sequential index into the array.

Return Value

Type: BaseArray
Copy/clone of the elements value. Scalar values are wrapped into a scalar array.

Usage Note

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

IndexOutOfRangeExceptionif the value of d0 exceeds the NumberOfElements of A.

This functions retrieves the value of the element at sequential index d0. Note that the index provided in d0 does not correspond to the storage position of the element to retrieve. This would only be true for special cases of storage layout and dimension numbers. For arbitrary storage layouts both are likely to differ.

The type of the array returned corresponds to the type of the element addressed by d0. Use GetValueT(BaseArrayBaseArray, Int64) in order to retrieve the element as its natural type. IsTypeOfCellT(ConcreteArrayBaseArray, Cell, InCell, OutCell, RetCell, CellStorage, Int64) can be used to inspect the element type.

Note, that the value addressed is not wrapped into a scalar cell before returning as would be the case for indexers on cells, which always return cells. Thus the return value might be a cell or an ILNumerics array of any element type. Commonly, the value returned will be a volatile return type array. Thus, it will be released after the first use.

[ILNumerics Core Module]

See Also