ILNumerics - Technical Application Development
Assembly: ILNumerics.Core (in ILNumerics.Core.dll) Version: 5.5.0.0 (5.5.7503.3146)
Sets the value of the element addressed by index array dims.
[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<T1, LocalT, InT, OutT, RetT, StorageT>( this Mutable<T1, LocalT, InT, OutT, RetT, StorageT> A, T1 value, InArray<long> dims ) where LocalT : Mutable<T1, LocalT, InT, OutT, RetT, StorageT> where InT : Immutable<T1, LocalT, InT, OutT, RetT, StorageT> where OutT : Mutable<T1, LocalT, InT, OutT, RetT, StorageT> where RetT : ConcreteRetArray<T1, LocalT, InT, OutT, RetT, StorageT> where StorageT : new(), BaseStorage<T1, LocalT, InT, OutT, RetT, StorageT>
Parameters
- A
- Type: ILNumerics.Core.ArraysMutableT1, LocalT, InT, OutT, RetT, StorageT
This mutable array. - value
- Type: T1
The new value. - dims
- Type: ILNumericsInArrayInt64
Index array addressing the elements location in all referenced dimensions.
Type Parameters
- T1
- LocalT
- InT
- OutT
- RetT
- StorageT
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type MutableT1, LocalT, InT, OutT, RetT, StorageT. 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. |
InvalidOperationException | if this array is currently in use by other arrays and locked against modifications. This should not happen during 'regular' use and often indicate bad design. |
Remarks
This function replaces a single value of A at the position as specified by the dimensional indices dims
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 arrays 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