ExtensionMethodsGetValueT 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.0.0 (5.5.7503.3146)

Syntax

public static T GetValue<T>(
	this BaseArray<BaseArray> A
)

<ExtensionAttribute>
Public Shared Function GetValue(Of T) ( 
	A As BaseArray(Of BaseArray)
) As T

Dim A As BaseArray(Of BaseArray)
Dim returnValue As T

returnValue = A.GetValue()

Parameters

A: Type: ILNumericsBaseArrayBaseArray
The cell instance.

Type Parameters

T

Return Value

Type: T
Copy/clone of the element value. Scalar values are not wrapped and returned as their natural type T.

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).

Exceptions

Exception	Condition
IndexOutOfRangeException	if A is not a 0-dimensional (numpy) scalar.

Remarks

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]

Reference

ExtensionMethods Class

GetValue Overload

ILNumerics Namespace

ExtensionMethodsIsTypeOfCellT(ConcreteArrayBaseArray, Cell, InCell, OutCell, RetCell, CellStorage, Int64)

ExtensionMethods.ToRetArray``1(BaseArray)

ExtensionMethodsGetValueT(BaseArrayBaseArray, Int64, Int64)

SizeGetSeqIndex(UInt32)

ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageTGetHostPointerForRead(NullableStorageOrders)

ArrayTGetHostPointerForWrite(NullableStorageOrders)