ILNumerics Ultimate VS

ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT Class

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Inheritance Hierarchy

SystemObject
  ILNumericsBaseArray
    ILNumericsBaseArrayT1
      ILNumerics.Core.ArraysConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT
        ILNumerics.Core.ArraysImmutableT1, LocalT, InT, OutT, RetT, StorageT
        ILNumerics.Core.ArraysMutableT1, LocalT, InT, OutT, RetT, StorageT

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

public abstract class ConcreteArray<T1, LocalT, InT, OutT, RetT, StorageT> : BaseArray<T1>, 
	IEnumerable<T1>, IEnumerable
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>

Type Parameters

T1
The element type.
LocalT
The type of the local arrays: one of ArrayT, Logical or Cell.
InT
The type of the input arrays: InArrayT, InLogical, or InCell respectively.
OutT
The type of the output arrays: OutArrayT, OutLogical, or OutCell respectively.
RetT
The type of the output arrays: RetArrayT1, RetLogical, or RetCell respectively.
StorageT
The concrete type of the internal storage object, determining all array types involved. This is derived from BaseStorageT, LocalT, InT, OutT, RetT, StorageT.

The ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT type exposes the following members.

Properties

  NameDescription
Public propertyC
Create lazy, shallow clone of this array.

[ILNumerics Core Module]

Public propertyIsColumnVector
Determines whether this array represents a column vector.

[ILNumerics Core Module]

(Overrides BaseArrayIsColumnVector.)
Public propertyIsComplex
Returns true if elements of this array store a real and an imaginary part each.

[ILNumerics Core Module]

(Overrides BaseArrayIsComplex.)
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]

(Overrides BaseArrayIsEmpty.)
Public propertyIsMatrix
Determines whether this array is a matrix.

[ILNumerics Core Module]

(Overrides BaseArrayIsMatrix.)
Public propertyIsNumeric
Gets whether this array stores elements of a numeric type.

[ILNumerics Core Module]

(Overrides BaseArrayIsNumeric.)
Public propertyIsRowVector
Gets whether this array represents a row vector [readonly].

[ILNumerics Core Module]

(Overrides BaseArrayIsRowVector.)
Public propertyIsScalar
Gets whether this array has exactly one element.

[ILNumerics Core Module]

(Overrides BaseArrayIsScalar.)
Public propertyIsVector
Determines if this array represents a vector.

[ILNumerics Core Module]

(Overrides BaseArrayIsVector.)
Public propertyLength
Gets the number of elements stored in the longest dimension [readonly].

[ILNumerics Core Module]

(Overrides BaseArrayLength.)
Public propertyMaxValue Obsolete.
Retrieves the maximum value among all elements of this array.

[ILNumerics Core Module]

Public propertyMinValue Obsolete.
Retrieves the minimum value among all elements of this array.

[ILNumerics Core Module]

Public propertyReferenceCount
Gets the number of arrays currently sharing the storage with this array.

[ILNumerics Core Module]

(Overrides BaseArrayReferenceCount.)
Public propertyS
Gets the dimension descriptor for this array (readonly). This is an alias for Size.

[ILNumerics Core Module]

(Overrides BaseArrayS.)
Public propertySize
Gets the dimension descriptor for this array. [readonly]

[ILNumerics Core Module]

(Overrides BaseArraySize.)
Public propertyT
Return transposed version of this array.

[ILNumerics Core Module]

Top
Methods

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

[ILNumerics Core Module]

(Overrides BaseArrayEquals(Object).)
Public methodEquals(ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT)
Test if this array equals another array.

[ILNumerics Core Module]

Public methodExportValues
(Expert API) Export (copy) values into System.Array.

[ILNumerics Core Module]

Public methodFinish
Waits for any pending operation writing to this array.

[ILNumerics Core Module]

Public methodGetArrayForRead
Gets a copy of the array elements for read access.

[ILNumerics Core Module]

Public methodGetElementType
Gets a Type object describing the element type T1.

[ILNumerics Core Module]

(Overrides BaseArrayGetElementType.)
Public methodGetEnumerator
Enumerator returning elements as T1 in column major order.

[ILNumerics Core Module]

Public methodGetHashCode
Generate a hash code based on the current values.

[ILNumerics Core Module]

(Overrides ObjectGetHashCode.)
Public methodGetHostPointerForRead
[Expert API - UNSAFE!] Acquire a read 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]

(Overrides BaseArrayGetItem(Int64).)
Public methodGetProfileInfo
Returns the performance profiling information of the last command writing to this array, if available.

[ILNumerics Core Module]

Public methodIsOfTypeElementType
Tests if this base array stores elements of type ElementType.

[ILNumerics Core Module]

(Overrides BaseArrayIsOfTypeElementType.)
Public methodReshape(Int64)
Creates reshaped version of this array, accepts variable length arguments array.

[ILNumerics Core Module]

Public methodReshape(Int64, NullableStorageOrders)
Create reshaped, 1 dimensional version of this array. Flattens the array to a vector.

[ILNumerics Core Module]

Public methodReshape(Int64, NullableStorageOrders) Obsolete.
Creates reshaped version, accepts dimension lengths as array.

[ILNumerics Core Module]

Public methodReshape(UInt32, NullableStorageOrders)
Creates reshaped version, accepts dimension lengths as array.

[ILNumerics Core Module]

Public methodReshape(Int64, Int64, NullableStorageOrders)
Create reshaped version of this storage.

[ILNumerics Core Module]

Public methodReshape(Int64, Int64, Int64, NullableStorageOrders)
Create reshaped version of this storage.

[ILNumerics Core Module]

Public methodReshape(Int64, Int64, Int64, Int64, NullableStorageOrders)
Create reshaped version of this storage.

[ILNumerics Core Module]

Public methodReshape(Int64, Int64, Int64, Int64, Int64, NullableStorageOrders)
Create reshaped version of this storage.

[ILNumerics Core Module]

Public methodReshape(Int64, Int64, Int64, Int64, Int64, Int64, NullableStorageOrders)
Create reshaped version of this storage.

[ILNumerics Core Module]

Public methodReshape(Int64, Int64, Int64, Int64, Int64, Int64, Int64, NullableStorageOrders)
Create reshaped version of this storage.

[ILNumerics Core Module]

Public methodReshapeIndT(BaseArrayIndT, NullableStorageOrders)
Creates reshaped version, accepts dimension lengths as array.

[ILNumerics Core Module]

Public methodShortInfo
Converts this array into a short textual representation, displaying the type, shape and a few element values.

[ILNumerics Core Module]

(Overrides BaseArrayShortInfo.)
Public methodShortInfo(Boolean, Boolean, Boolean, Boolean)
Short textual summary of this instance, select individual info components.

[ILNumerics Core Module]

(Overrides BaseArrayShortInfo(Boolean, Boolean, Boolean, Boolean).)
Public methodSubarray(BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(DimSpec)
Extract part from this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(BaseArray, BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(DimSpec, DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(BaseArray, BaseArray, BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(DimSpec, DimSpec, DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(BaseArray, BaseArray, BaseArray, BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(DimSpec, DimSpec, DimSpec, DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(BaseArray, BaseArray, BaseArray, BaseArray, BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(DimSpec, DimSpec, DimSpec, DimSpec, DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(BaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(DimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(BaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodSubarray(DimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec)
Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

Public methodToStream Obsolete.
Convert and store content of this array into a stream. This function is obsolete.

[ILNumerics Core Module]

(Overrides BaseArrayToStream(Stream, String, ArrayStreamSerializationFlags).)
Public methodToString
Create textual description of this array. Limits the number of elements shown for very large arrays.

[ILNumerics Core Module]

(Overrides ObjectToString.)
Public methodToString(UInt32, UInt32, NullableStorageOrders, Boolean, Boolean, NullableInt32)
Creates a textual representation of this array and allows to control display parameters.

[ILNumerics Core Module]

(Overrides BaseArrayToString(UInt32, UInt32, NullableStorageOrders, Boolean, Boolean, NullableInt32).)
Public methodToXML
Writes a XML string in XML file

[ILNumerics Core Module]

(Inherited from BaseArrayT.)
Top
Operators

  NameDescription
Public operatorStatic memberAddition
Elementwise addition operator on two numeric arrays.

[ILNumerics Core Module]

Public operatorStatic memberBitwiseAnd
Binary, elementwise, bitwise/logical 'and' operator.

[ILNumerics Core Module]

Public operatorStatic memberBitwiseOr
Elementwise bitwise 'or' operator on two integer arrays.

[ILNumerics Core Module]

Public operatorStatic memberDivision
Elementwise division operator on two numeric arrays.

[ILNumerics Core Module]

Public operatorStatic memberEquality
Elementwise 'equals' comparison operator on two arrays.

[ILNumerics Core Module]

Public operatorStatic memberExclusiveOr
Elementwise bitwise 'xor' operator on two integer arrays.

[ILNumerics Core Module]

Public operatorStatic member(ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT to T1)
Cast scalar array to system value type.

[ILNumerics Core Module]

Public operatorStatic memberGreaterThan
Elementwise 'greater than' operator on two arrays.

[ILNumerics Core Module]

Public operatorStatic memberGreaterThanOrEqual
Elementwise 'greater or equal' operator on two arrays.

[ILNumerics Core Module]

Public operatorStatic member(T1 to ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT)
Implicitly convert system scalar A to a scalar array.

[ILNumerics Core Module]

Public operatorStatic memberInequality
Elementwise 'unequal to' operator on two arrays.

[ILNumerics Core Module]

Public operatorStatic memberLeftShift
Elementwise bitwise '<<' operator on two integer arrays.

[ILNumerics Core Module]

Public operatorStatic memberLessThan
Elementwise 'lower than' operator on two arrays.

[ILNumerics Core Module]

Public operatorStatic memberLessThanOrEqual
Elementwise 'lower or equal' operator on two arrays.

[ILNumerics Core Module]

Public operatorStatic memberLogicalNot
Logical negation operator.

[ILNumerics Core Module]

Public operatorStatic memberModulus
Elementwise modulo operator on two numeric arrays.

[ILNumerics Core Module]

Public operatorStatic memberMultiply
Elementwise multiplication operator on two numeric arrays.

[ILNumerics Core Module]

Public operatorStatic memberOnesComplement
Unary, bitwise negation operator.

[ILNumerics Core Module]

Public operatorStatic memberRightShift
Elementwise bitwise '>>' operator on two integer arrays.

[ILNumerics Core Module]

Public operatorStatic memberSubtraction
Elementwise subtraction operator on two numeric arrays.

[ILNumerics Core Module]

Public operatorStatic memberUnaryNegation
Unary, elementwise negation operator.

[ILNumerics Core Module]

Top
Fields

  NameDescription
Protected fieldm_storage
The internal storage reference.
Public fieldStatic memberSizeOfT
Gets the number of bytes spanned by a single element of this array.
Top
Extension Methods

  NameDescription
Public Extension MethodflattenT1 (Defined by ExtensionMethods.)
Public Extension MethodGetValueT1(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 MethodGetValueT1(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 MethodGetValueT1(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 MethodGetValueT1(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 MethodGetValueT1(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 MethodGetValueT1(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 MethodGetValueT1(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 MethodIndexIteratorT1
Efficient iterator over generic (but numeric!) type elements for use in indexing.

[ILNumerics Core Module]

(Defined by ExtensionMethods.)
Public Extension MethoditemT1(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 MethoditemT1(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 MethoditemT1(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 MethoditemT1(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 MethoditemT1(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 MethoditemT1(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 MethoditemT1(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 MethoditemT1(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 MethodIteratorT1
Efficient iterator over generic type elements for use in foreach loops.

[ILNumerics Core Module]

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

This class implements most of the abstract base class BaseArray public API. It also implements the public (strongly typed) API for mutable arrays and the non-volatile input array types (InArrayT, ...).

[ILNumerics Core Module]

See Also

Reference