ILNumerics Ultimate VS

ExtensionMethodsGetValue Method (BaseArrayBaseArray)

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Retrieves a clone of the value of a scalar (0-dim) cell array as an array. Supports deep indexing.

[ILNumerics Core Module]

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

public static BaseArray GetValue(
	this BaseArray<BaseArray> A


Type: ILNumericsBaseArrayBaseArray
The cell instance.

Return Value

Type: BaseArray
Copy/clone of the element value. Scalar arrays 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 A is not a 0-dimensional (numpy) scalar.

This functions retrieves the value of the only element of a 0-dim scalar cell array.

The type of the array returned corresponds to the type of the element stored. Use GetValueT(BaseArrayBaseArray) 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.

[ILNumerics Core Module]

See Also