ILNumerics Ultimate VS

ExtensionMethodsSetValue Method (MutableBaseArray, Cell, InCell, OutCell, RetCell, CellStorage, BaseArray)

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Sets the value of the scalar (0-dimensional) cell array A.

[ILNumerics Core Module]

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

public static void SetValue(
	this Mutable<BaseArray, Cell, InCell, OutCell, RetCell, CellStorage> A,
	BaseArray value
)

Parameters

A
Type: ILNumerics.Core.ArraysMutableBaseArray, Cell, InCell, OutCell, RetCell, CellStorage
This mutable, scalar (0-dim) array.
value
Type: ILNumericsBaseArray
The new value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type MutableBaseArray, Cell, InCell, OutCell, RetCell, CellStorage. 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

ExceptionCondition
OutOfMemoryException if the expanded size as determined by the given indices is too large to be allocated.
InvalidOperationExceptionif this array is currently in use by other arrays and locked against modifications. This should not happen during 'regular' use and may indicate a bad design.
Remarks

This function replaces the only value of the 0-dimensional scalar array A. It supports the deep-indexing feature on cell arrays. Regular arrays can be addressed by an index value 0 for virtual dimensions. In contrast to that indexing with integer values into cell arrays (deep indexing) requires exactly one index for each (non-virtual) dimension of every array addressed. Therefore, a 0-index overload exists for indexing into scalar (0-dim) cell arrays.

The function supports automatic expansion when addressing elements outside of the current dimension range. However, removal of parts of the array is not supported. Use the indexers defined on MutableT1, LocalT, InT, OutT, RetT, StorageT for removal operations in array style ILNumericsV4. It is recommended to initialize your arrays with a fixed size and to prevent from array size changing operations for best performance, though.

[ILNumerics Core Module]

See Also

Reference

Other Resources