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

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Sets the value of the element addressed by d0...d2. Supports deep indexing into cell elements.

[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,
	long d0,
	long d1,
	long d2
)

<ExtensionAttribute>
Public Shared Sub SetValue ( 
	A As Mutable(Of BaseArray, Cell, InCell, OutCell, RetCell, CellStorage),
	value As BaseArray,
	d0 As Long,
	d1 As Long,
	d2 As Long
)

Dim A As Mutable(Of BaseArray, Cell, InCell, OutCell, RetCell, CellStorage)
Dim value As BaseArray
Dim d0 As Long
Dim d1 As Long
Dim d2 As Long

A.SetValue(value, d0, d1, d2)

Parameters

A: Type: ILNumerics.Core.ArraysMutableBaseArray, Cell, InCell, OutCell, RetCell, CellStorage
This mutable array.
value: Type: ILNumericsBaseArray
The new value.
d0: Type: SystemInt64
Index into dimension #0.
d1: Type: SystemInt64
Index into dimension #1.
d2: Type: SystemInt64
Index into dimension #2.

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

Exception	Condition
OutOfMemoryException	if the expanded size as determined by the given indices is too large to be allocated.

Remarks

This function replaces a single value of A at the position as specified by the dimensional indices d0 ... d2.

d2 is considered a sequential index into its own and into subsequent, merged dimensions (Matlab/ILNumericsV4 indexing style).

Deep indexing: the element to be replaced is located by matching the full set of given indices with the existing dimensions of the cell, starting with index d0. If the indices corresponding to the number of dimensions of this cell point to an ILNumerics array subsequent indices are used as indices into that array. On the other hand, if the element found is a cell, indexing is continued recursively at that cell element.

The function supports automatic expansion for existing dimensions of regular (non-cell) arrays. When the given indices address a non-existing element of a non-cell array the array currently stored in the cell is expanded in a way that the new value can be stored at the provided location of the array.

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]

Reference

ExtensionMethods Class

SetValue Overload

ILNumerics Namespace

MutableT1, LocalT, InT, OutT, RetT, StorageTSetRange(BaseArrayT1, DimSpec, DimSpec)

ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageTGetItem(Int64)

ExtensionMethodsGetValue(BaseArrayBoolean, Int64)

ArrayTGetHostPointerForWrite(NullableStorageOrders)

Other Resources

ILNumerics cell arrays tutorial online.

Subarray tutorial in the ILNumerics online documentation