ILNumerics Ultimate VS

ArrayT Class

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
The main n-dimensional, rectilinear array to be used in algorithms.

[ILNumerics Core Module]

Inheritance Hierarchy

SystemObject
  ILNumericsBaseArray
    ILNumericsBaseArrayT
      ILNumerics.Core.ArraysConcreteArrayT, ArrayT, InArrayT, OutArrayT, RetArrayT, StorageT
        ILNumerics.Core.ArraysMutableT, ArrayT, InArrayT, OutArrayT, RetArrayT, StorageT
          ILNumericsArrayT

Namespace:  ILNumerics
Assembly:  ILNumerics.Core (in ILNumerics.Core.dll) Version: 5.4.0.0 (5.4.7431.3055)
Syntax

[SerializableAttribute]
public sealed class Array<T> : Mutable<T, Array<T>, InArray<T>, OutArray<T>, RetArray<T>, Storage<T>>

Type Parameters

T
Inner type. This will mostly be one of the predefined numeric ValueType types or one of the complex ILNumerics floating point types: complex and fcomplex.

The ArrayT type exposes the following members.

Properties

  NameDescription
Public propertya
Assign another array to this array variable. This is an optional, yet more efficient alternative to using '=' for assigning to the array directly.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyC
Create lazy, shallow clone of this array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertydata
[numpy API][Expert API!] Gives a reference to the memory handle used to store elements of this array on the host.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyflat
Readonly iterator over the elements of this array in row-major order.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyIsColumnVector
Determines whether this array represents a column vector.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyIsComplex
Returns true if elements of this array store a real and an imaginary part each.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyCode exampleIsDisposed
This flag indicates that an array is not to be used anymore.

[ILNumerics Core Module]

(Inherited from BaseArray.)
Public propertyIsEmpty
Determines whether this array stores no elements.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyIsMatrix
Determines whether this array is a matrix.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyIsNumeric
Gets whether this array stores elements of a numeric type.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyIsRowVector
Gets whether this array represents a row vector [readonly].

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyIsScalar
Gets whether this array has exactly one element.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyIsVector
Determines if this array represents a vector.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemInt64
Retrieves the value(s) of the element(s) at the position specified by d0 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemUInt32
Retrieves the value(s) of the element(s) at the position specified by d0 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemBaseArray
Gets a subarray from this array or replaces the values of parts of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemBaseArray
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemDimSpec
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemDimSpec
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemInt64, Int64
Retrieves the value(s) of the element(s) at the position specified by d0 and d1 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemUInt32, UInt32
Retrieves the value(s) of the element(s) at the position specified by d0 and d1 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemBaseArray, BaseArray
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemDimSpec, DimSpec
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemInt64, Int64, Int64
Retrieves the value(s) of the element(s) at the position specified by d0 ... d2 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemUInt32, UInt32, UInt32
Retrieves the value(s) of the element(s) at the position specified by d0 ... d2 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemBaseArray, BaseArray, BaseArray
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemDimSpec, DimSpec, DimSpec
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemInt64, Int64, Int64, Int64
Retrieves the value(s) of the element(s) at the position specified by d0 ... d3 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemUInt32, UInt32, UInt32, UInt32
Retrieves the value(s) of the element(s) at the position specified by d0 ... d3 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemBaseArray, BaseArray, BaseArray, BaseArray
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemDimSpec, DimSpec, DimSpec, DimSpec
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemInt64, Int64, Int64, Int64, Int64
Retrieves the value(s) of the element(s) at the position specified by d0 ... d4 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemUInt32, UInt32, UInt32, UInt32, UInt32
Retrieves the value(s) of the element(s) at the position specified by d0 ... d4 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemBaseArray, BaseArray, BaseArray, BaseArray, BaseArray
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemDimSpec, DimSpec, DimSpec, DimSpec, DimSpec
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemInt64, Int64, Int64, Int64, Int64, Int64
Retrieves the value(s) of the element(s) at the position specified by d0 ... d5 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemUInt32, UInt32, UInt32, UInt32, UInt32, UInt32
Retrieves the value(s) of the element(s) at the position specified by d0 ... d5 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemBaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemDimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemInt64, Int64, Int64, Int64, Int64, Int64, Int64
Retrieves the value(s) of the element(s) at the position specified by d0 ... d6 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemUInt32, UInt32, UInt32, UInt32, UInt32, UInt32, UInt32
Retrieves the value(s) of the element(s) at the position specified by d0 ... d6 or sets them.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemBaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyItemDimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec
Gets a subarray from this array or replaces the values of part of this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyitemsize
[numpy API] The number of bytes required to store a single element T1 in memory. [readonly]

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyLength
Gets the number of elements stored in the longest dimension [readonly].

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyMaxValue Obsolete.
Retrieves the maximum value among all elements of this array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyMinValue Obsolete.
Retrieves the minimum value among all elements of this array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertynbytes
[numpy API] The total number of bytes required to store all elements of this array. [readonly]

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyndim
[numpy API] The number of dimensions stored for this array.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyReferenceCount
Gets the number of arrays currently sharing the storage with this array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyS
Gets the dimension descriptor for this array (readonly). This is an alias for Size.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyshape
[numpy API] The dimension lengths as ILNumerics vector of length corresponding to NumberOfDimensions.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertySize
Gets the dimension descriptor for this array. [readonly]

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertysize_
[numpy API] Gives the number of elements in this array. This attribute is an alias for NumberOfElements. [readonly]

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertystrides
[numpy API] The strides of elements within the dimensions. Unit: element size.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public propertyT
Return transposed version of this array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Top
Methods

  NameDescription
Public methodAssign
Assign another array to this array variable. This is an optional, yet more efficient alternative to using '=' for assigning to the array directly.

[ILNumerics Core Module]

(Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodDispose
Release this array after use. Cleans up on ArrayT, Cell and Logical arrays which are not inside a Enter(BaseArray, NullableArrayStyles) block.

[ILNumerics Core Module]

Public methodEquals(Object)
Test if this array equals another array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodEquals(ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT)
Test if this array equals another array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodExportValues
(Expert API) Export (copy) values into System.Array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodFinish
Waits for any pending operation writing to this array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodGetArrayForRead
Gets a copy of the array elements for read access.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodGetElementType
Gets a Type object describing the element type T1.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodGetEnumerator
Enumerator returning elements as T1 in column major order.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodGetHashCode
Generate a hash code based on the current values.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodGetHostPointerForRead
[Expert API - UNSAFE!] Acquire a read pointer to the memory storing the first element of this array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodCode exampleGetHostPointerForWrite
[Expert API - UNSAFE!] Acquire a writable pointer to the memory storing the first element of this array.

[ILNumerics Core Module]

Public methodGetItem
Retrieve the element addressed by the sequential index i.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodGetProfileInfo
Returns the performance profiling information of the last command writing to this array, if available.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodIsOfTypeElementType
Tests if this base array stores elements of type ElementType.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodReshape(Int64)
Creates reshaped version of this array, accepts variable length arguments array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodReshape(Int64, NullableStorageOrders)
Create reshaped, 1 dimensional version of this array. Flattens the array to a vector.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodReshape(Int64, NullableStorageOrders) Obsolete.
Creates reshaped version, accepts dimension lengths as array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodReshape(UInt32, NullableStorageOrders)
Creates reshaped version, accepts dimension lengths as array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodReshape(Int64, Int64, NullableStorageOrders)
Create reshaped version of this storage.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodReshape(Int64, Int64, Int64, NullableStorageOrders)
Create reshaped version of this storage.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodReshape(Int64, Int64, Int64, Int64, NullableStorageOrders)
Create reshaped version of this storage.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodReshape(Int64, Int64, Int64, Int64, Int64, NullableStorageOrders)
Create reshaped version of this storage.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodReshape(Int64, Int64, Int64, Int64, Int64, Int64, NullableStorageOrders)
Create reshaped version of this storage.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodReshape(Int64, Int64, Int64, Int64, Int64, Int64, Int64, NullableStorageOrders)
Create reshaped version of this storage.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodReshapeIndT(BaseArrayIndT, NullableStorageOrders)
Creates reshaped version, accepts dimension lengths as array.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, BaseArray) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, BaseArray) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, DimSpec) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, DimSpec) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, BaseArray, BaseArray) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, DimSpec, DimSpec) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, BaseArray, BaseArray, BaseArray) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, DimSpec, DimSpec, DimSpec) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, BaseArray, BaseArray, BaseArray, BaseArray) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, DimSpec, DimSpec, DimSpec, DimSpec) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSetRange(BaseArrayT1, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec) (Inherited from MutableT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodShortInfo
Converts this array into a short textual representation, displaying the type, shape and a few element values.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodShortInfo(Boolean, Boolean, Boolean, Boolean)
Short textual summary of this instance, select individual info components.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(DimSpec)
Extract part from this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(BaseArray, BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(DimSpec, DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(BaseArray, BaseArray, BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(DimSpec, DimSpec, DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(BaseArray, BaseArray, BaseArray, BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(DimSpec, DimSpec, DimSpec, DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(BaseArray, BaseArray, BaseArray, BaseArray, BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(DimSpec, DimSpec, DimSpec, DimSpec, DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(BaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(DimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(BaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodSubarray(DimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodToStream Obsolete.
Convert and store content of this array into a stream. This function is obsolete.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodToString
Create textual description of this array. Limits the number of elements shown for very large arrays.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodToString(UInt32, UInt32, NullableStorageOrders, Boolean, Boolean, NullableInt32)
Creates a textual representation of this array and allows to control display parameters.

[ILNumerics Core Module]

(Inherited from ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT.)
Public methodToXML
Writes a XML string in XML file

[ILNumerics Core Module]

(Inherited from BaseArrayT.)
Top
Operators

  NameDescription
Public operatorStatic memberCode example(Array to ArrayT)
Implicitly convert n-dimensional System.Array to ILNumerics array.

[ILNumerics Core Module]

Public operatorStatic member(T to ArrayT)
Wraps single value into scalar array.

[ILNumerics Core Module]

Public operatorStatic member(InArrayT to ArrayT)
Convert input array (immutable) to local array (mutable).

[ILNumerics Core Module]

Public operatorStatic member(OutArrayT to ArrayT)
Convert output array to a new local array (mutable).

[ILNumerics Core Module]

Public operatorStatic member(RetArrayT to ArrayT)
"Persistence cast" make a steady array out of a temp array

[ILNumerics Core Module]

Top
Extension Methods

  NameDescription
Public Extension MethodflattenT (Defined by ExtensionMethods.)
Public Extension MethodGetValueT(Int64)Overloaded.
Retrieves the value of the element at the position as specified by d0. Int64 indexing.

[ILNumerics Core Module]

(Defined by ExtensionMethods.)
Public Extension MethodGetValueT(Int64, Int64)Overloaded.
Retrieve the value of the element at the position specified by d0 and d1. Int64 indexing.

[ILNumerics Core Module]

(Defined by ExtensionMethods.)
Public Extension MethodGetValueT(Int64, Int64, Int64)Overloaded.
Retrieve the value of the element at the position specified by d0 ... d2. Int64 indexing.

[ILNumerics Core Module]

(Defined by ExtensionMethods.)
Public Extension MethodGetValueT(Int64, Int64, Int64, Int64)Overloaded.
Retrieve the value of the element at the position specified by d0 ... d3. Int64 indexing.

[ILNumerics Core Module]

(Defined by ExtensionMethods.)
Public Extension MethodGetValueT(Int64, Int64, Int64, Int64, Int64)Overloaded.
Retrieve the value of the element at the position specified by d0 ... d4. Int64 indexing.

[ILNumerics Core Module]

(Defined by ExtensionMethods.)
Public Extension MethodGetValueT(Int64, Int64, Int64, Int64, Int64, Int64)Overloaded.
Retrieve the value of the element at the position specified by d0 ... d5. Int64 indexing.

[ILNumerics Core Module]

(Defined by ExtensionMethods.)
Public Extension MethodGetValueT(Int64, Int64, Int64, Int64, Int64, Int64, Int64)Overloaded.
Retrieve the value of the element at the position specified by d0 ... d6. Int64 indexing.

[ILNumerics Core Module]

(Defined by ExtensionMethods.)
Public Extension MethodIndexIteratorT
Efficient iterator over generic (but numeric!) type elements for use in indexing.

[ILNumerics Core Module]

(Defined by ExtensionMethods.)
Public Extension MethoditemT(Int64)Overloaded.
[numpy API] Returns a single element from this array according to the provided dimension index.

[ILNumerics numpy Module]

(Defined by ExtensionMethods.)
Public Extension MethoditemT(Int64)Overloaded.
[numpy API] Returns a single element from this array according to the provided dimension indices.

[ILNumerics numpy Module]

(Defined by ExtensionMethods.)
Public Extension MethoditemT(Int64, Int64)Overloaded.
[numpy API] Returns a single element from this array according to the provided dimension indices.

[ILNumerics numpy Module]

(Defined by ExtensionMethods.)
Public Extension MethoditemT(Int64, Int64, Int64)Overloaded.
[numpy API] Returns a single element from this array according to the provided dimension indices.

[ILNumerics numpy Module]

(Defined by ExtensionMethods.)
Public Extension MethoditemT(Int64, Int64, Int64, Int64)Overloaded.
[numpy API] Returns a single element from this array according to the provided dimension indices.

[ILNumerics numpy Module]

(Defined by ExtensionMethods.)
Public Extension MethoditemT(Int64, Int64, Int64, Int64, Int64)Overloaded.
[numpy API] Returns a single element from this array according to the provided dimension indices.

[ILNumerics numpy Module]

(Defined by ExtensionMethods.)
Public Extension MethoditemT(Int64, Int64, Int64, Int64, Int64, Int64)Overloaded.
[numpy API] Returns a single element from this array according to the provided dimension indices.

[ILNumerics numpy Module]

(Defined by ExtensionMethods.)
Public Extension MethoditemT(Int64, Int64, Int64, Int64, Int64, Int64, Int64)Overloaded.
[numpy API] Returns a single element from this array according to the provided dimension indices.

[ILNumerics numpy Module]

(Defined by ExtensionMethods.)
Public Extension MethodIteratorT
Efficient iterator over generic type elements for use in foreach loops.

[ILNumerics Core Module]

(Defined by ExtensionMethods.)
Public Extension MethodravelT (Defined by ExtensionMethods.)
Top
Remarks

This class serves as the main rectilinear array, holding arbitrary elements (usually numeric types or BaseArray) in arbitrary dimensions.

Arrays of this type may use any type as generic element. However, common mathematical functions and operators are defined for a limited number of value type elements only. All binary operations (+,-,*,/,<,>,<=,etc.) are defined for two arrays with the same numeric type, would it be from the System namespace (Double, Int32, ...) or complex/ fcomplex. Most algebraic functions require floating point types. See the ILNumerics.Math class for a list of all computational functions.

Arrays are capable of creating flexible subarrays and are mutable at runtime. Read about all details of ILNumerics arrays in the ILNumerics Array documentation.

Arrays of this type are dense arrays. Cloning arrays is done as lazy copy on write, i.e.: clones of existing arrays do only use new memory when attempting to alter one of them. Arrays integrate into the memory management of ILNumerics. Read about the most important simple rules for using arrays in custom computational functions.

Arrays come with overloaded mathematical operators, allowing for a convenient syntax. A sophisticated memory management in the back will make sure, that as little memory is used as absolutely needed, even in non-trivial expressions, like: a + c * 2 / abs(sin(c) * -b / log(a)). Here all arrays are of the same or broadcastable size. Evaluating this expression does only need the memory of twice the size of one array. Memory gets collected and reused for every subexpression evaluation. Further optimization options exist, as described in Optimizing Algorithm Performance.

[ILNumerics Core Module]

Examples

A simple example demonstrating the uses of Array<double> in a very simple application:

using System;
            using System.Collections.Generic;
            using System.Linq;
            using System.Text;
            using ILNumerics; 
            using static ILNumerics.ILMath;
            using static ILNumerics.Globals;

            namespace ConsoleApplication1 {
                class Program {
                    static void Main(string[] args) {
                        using (Scope.Enter()) {
                            Array<double> A = rand(10,20);
                            Array<double> B = A * 30 + 100; 
                            Logical C = any(multiply(B,B.T)); 
                            Console.Out.Write(-B); 
                            Console.ReadKey(); 
                        }
                    }
                }
            }
See Also

Reference

Other Resources