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

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Abstract base class for concrete array implementations of type ArrayT, OutArrayT, InArrayT and their conterparts for Logical and Cell. This class is not intended to be used directly. Use the concrete derived array classes instead!

[ILNumerics Core Module]

General base class for array objects like ArrayT and similar arrays types.

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.5.0.0 (5.5.7503.3146)

Syntax

Copy

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>

Public MustInherit Class ConcreteArray(Of T1, LocalT As Mutable(Of T1, LocalT, InT, OutT, RetT, StorageT), InT As Immutable(Of T1, LocalT, InT, OutT, RetT, StorageT), OutT As Mutable(Of T1, LocalT, InT, OutT, RetT, StorageT), RetT As ConcreteRetArray(Of T1, LocalT, InT, OutT, RetT, StorageT), StorageT As {New, BaseStorage(Of T1, LocalT, InT, OutT, RetT, StorageT)})
	Inherits BaseArray(Of T1)
	Implements IEnumerable(Of T1), IEnumerable

Dim instance As ConcreteArray(Of 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

	Name	Description
	C	Create lazy, shallow clone of this array. [ILNumerics Core Module]
	IsColumnVector	Determines whether this array represents a column vector. [ILNumerics Core Module] (Overrides BaseArrayIsColumnVector.)
	IsComplex	Returns true if elements of this array store a real and an imaginary part each. [ILNumerics Core Module] (Overrides BaseArrayIsComplex.)
	IsDisposed	This flag indicates that an array is not to be used anymore. [ILNumerics Core Module] (Inherited from BaseArray.)
	IsEmpty	Determines whether this array stores no elements. [ILNumerics Core Module] (Overrides BaseArrayIsEmpty.)
	IsMatrix	Determines whether this array is a matrix. [ILNumerics Core Module] (Overrides BaseArrayIsMatrix.)
	IsNumeric	Gets whether this array stores elements of a numeric type. [ILNumerics Core Module] (Overrides BaseArrayIsNumeric.)
	IsRowVector	Gets whether this array represents a row vector [readonly]. [ILNumerics Core Module] (Overrides BaseArrayIsRowVector.)
	IsScalar	Gets whether this array has exactly one element. [ILNumerics Core Module] (Overrides BaseArrayIsScalar.)
	IsVector	Determines if this array represents a vector. [ILNumerics Core Module] (Overrides BaseArrayIsVector.)
	Length	Gets the number of elements stored in the longest dimension [readonly]. [ILNumerics Core Module] (Overrides BaseArrayLength.)
	MaxValue	Obsolete. Retrieves the maximum value among all elements of this array. [ILNumerics Core Module]
	MinValue	Obsolete. Retrieves the minimum value among all elements of this array. [ILNumerics Core Module]
	ReferenceCount	Gets the number of arrays currently sharing the storage with this array. [ILNumerics Core Module] (Overrides BaseArrayReferenceCount.)
	S	Gets the dimension descriptor for this array (readonly). This is an alias for Size. [ILNumerics Core Module] (Overrides BaseArrayS.)
	Size	Gets the dimension descriptor for this array. [readonly] [ILNumerics Core Module] (Overrides BaseArraySize.)
	T	Return transposed version of this array. [ILNumerics Core Module]

Top

Methods

	Name	Description
	Equals(Object)	Test if this array equals another array. [ILNumerics Core Module] (Overrides BaseArrayEquals(Object).)
	Equals(ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT)	Test if this array equals another array. [ILNumerics Core Module]
	ExportValues	(Expert API) Export (copy) values into System.Array. [ILNumerics Core Module]
	Finish	Waits for any pending operation writing to this array. [ILNumerics Core Module]
	GetArrayForRead	Gets a copy of the array elements for read access. [ILNumerics Core Module]
	GetElementType	Gets a Type object describing the element type T1. [ILNumerics Core Module] (Overrides BaseArrayGetElementType.)
	GetEnumerator	Enumerator returning elements as T1 in column major order. [ILNumerics Core Module]
	GetHashCode	Generate a hash code based on the current values. [ILNumerics Core Module] (Overrides ObjectGetHashCode.)
	GetHostPointerForRead	[Expert API - UNSAFE!] Acquire a read pointer to the memory storing the first element of this array. [ILNumerics Core Module]
	GetItem	Retrieve the element addressed by the sequential index i. [ILNumerics Core Module] (Overrides BaseArrayGetItem(Int64).)
	GetProfileInfo	Returns the performance profiling information of the last command writing to this array, if available. [ILNumerics Core Module]
	IsOfTypeElementType	Tests if this base array stores elements of type ElementType. [ILNumerics Core Module] (Overrides BaseArrayIsOfTypeElementType.)
	Reshape(Int64)	Creates reshaped version of this array, accepts variable length arguments array. [ILNumerics Core Module]
	Reshape(Int64, NullableStorageOrders)	Create reshaped, 1 dimensional version of this array. Flattens the array to a vector. [ILNumerics Core Module]
	Reshape(Int64, NullableStorageOrders)	Obsolete. Creates reshaped version, accepts dimension lengths as array. [ILNumerics Core Module]
	Reshape(UInt32, NullableStorageOrders)	Creates reshaped version, accepts dimension lengths as array. [ILNumerics Core Module]
	Reshape(Int64, Int64, NullableStorageOrders)	Create reshaped version of this storage. [ILNumerics Core Module]
	Reshape(Int64, Int64, Int64, NullableStorageOrders)	Create reshaped version of this storage. [ILNumerics Core Module]
	Reshape(Int64, Int64, Int64, Int64, NullableStorageOrders)	Create reshaped version of this storage. [ILNumerics Core Module]
	Reshape(Int64, Int64, Int64, Int64, Int64, NullableStorageOrders)	Create reshaped version of this storage. [ILNumerics Core Module]
	Reshape(Int64, Int64, Int64, Int64, Int64, Int64, NullableStorageOrders)	Create reshaped version of this storage. [ILNumerics Core Module]
	Reshape(Int64, Int64, Int64, Int64, Int64, Int64, Int64, NullableStorageOrders)	Create reshaped version of this storage. [ILNumerics Core Module]
	ReshapeIndT(BaseArrayIndT, NullableStorageOrders)	Creates reshaped version, accepts dimension lengths as array. [ILNumerics Core Module]
	ShortInfo	Converts this array into a short textual representation, displaying the type, shape and a few element values. [ILNumerics Core Module] (Overrides BaseArrayShortInfo.)
	ShortInfo(Boolean, Boolean, Boolean, Boolean)	Short textual summary of this instance, select individual info components. [ILNumerics Core Module] (Overrides BaseArrayShortInfo(Boolean, Boolean, Boolean, Boolean).)
	Subarray(BaseArray)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(BaseArray)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(DimSpec)	Extract part from this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(DimSpec)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(BaseArray, BaseArray)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(DimSpec, DimSpec)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(BaseArray, BaseArray, BaseArray)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(DimSpec, DimSpec, DimSpec)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(BaseArray, BaseArray, BaseArray, BaseArray)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(DimSpec, DimSpec, DimSpec, DimSpec)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(BaseArray, BaseArray, BaseArray, BaseArray, BaseArray)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(DimSpec, DimSpec, DimSpec, DimSpec, DimSpec)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(BaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(DimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(BaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray, BaseArray)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	Subarray(DimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec, DimSpec)	Extract part of this array. Matlab® and numpy indexing. [ILNumerics Core Module]
	ToStream	Obsolete. Convert and store content of this array into a stream. This function is obsolete. [ILNumerics Core Module] (Overrides BaseArrayToStream(Stream, String, ArrayStreamSerializationFlags).)
	ToString	Create textual description of this array. Limits the number of elements shown for very large arrays. [ILNumerics Core Module] (Overrides ObjectToString.)
	ToString(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).)
	ToXML	Writes a XML string in XML file [ILNumerics Core Module] (Inherited from BaseArrayT.)

Top

Operators

	Name	Description
	Addition	Elementwise addition operator on two numeric arrays. [ILNumerics Core Module]
	BitwiseAnd	Binary, elementwise, bitwise/logical 'and' operator. [ILNumerics Core Module]
	BitwiseOr	Elementwise bitwise 'or' operator on two integer arrays. [ILNumerics Core Module]
	Division	Elementwise division operator on two numeric arrays. [ILNumerics Core Module]
	Equality	Elementwise 'equals' comparison operator on two arrays. [ILNumerics Core Module]
	ExclusiveOr	Elementwise bitwise 'xor' operator on two integer arrays. [ILNumerics Core Module]
	(ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT to T1)	Cast scalar array to system value type. [ILNumerics Core Module]
	GreaterThan	Elementwise 'greater than' operator on two arrays. [ILNumerics Core Module]
	GreaterThanOrEqual	Elementwise 'greater or equal' operator on two arrays. [ILNumerics Core Module]
	(T1 to ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageT)	Implicitly convert system scalar A to a scalar array. [ILNumerics Core Module]
	Inequality	Elementwise 'unequal to' operator on two arrays. [ILNumerics Core Module]
	LeftShift	Elementwise bitwise '<<' operator on two integer arrays. [ILNumerics Core Module]
	LessThan	Elementwise 'lower than' operator on two arrays. [ILNumerics Core Module]
	LessThanOrEqual	Elementwise 'lower or equal' operator on two arrays. [ILNumerics Core Module]
	LogicalNot	Logical negation operator. [ILNumerics Core Module]
	Modulus	Elementwise modulo operator on two numeric arrays. [ILNumerics Core Module]
	Multiply	Elementwise multiplication operator on two numeric arrays. [ILNumerics Core Module]
	OnesComplement	Unary, bitwise negation operator. [ILNumerics Core Module]
	RightShift	Elementwise bitwise '>>' operator on two integer arrays. [ILNumerics Core Module]
	Subtraction	Elementwise subtraction operator on two numeric arrays. [ILNumerics Core Module]
	UnaryNegation	Unary, elementwise negation operator. [ILNumerics Core Module]

Top

Fields

	Name	Description
	m_storage	The internal storage reference.
	SizeOfT	Gets the number of bytes spanned by a single element of this array.

Top

Extension Methods

	Name	Description
	flattenT1	[numpy API] Returns a flattened copy of the source array. This is the same as ravelT1(BaseArrayT1, StorageOrders). See remarks for details. [ILNumerics numpy Module] (Defined by ExtensionMethods.)
	GetValueT1(Int64)	Overloaded. Retrieves the value of the element at the position as specified by d0. Int64 indexing. [ILNumerics Core Module] (Defined by ExtensionMethods.)
	GetValueT1(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.)
	GetValueT1(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.)
	GetValueT1(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.)
	GetValueT1(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.)
	GetValueT1(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.)
	GetValueT1(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.)
	IndexIteratorT1	Efficient iterator over generic (but numeric!) type elements for use in indexing. [ILNumerics Core Module] (Defined by ExtensionMethods.)
	itemT1(Int64)	Overloaded. [numpy API] Returns a single element from this array according to the provided dimension index. [ILNumerics numpy Module] (Defined by ExtensionMethods.)
	itemT1(Int64)	Overloaded. [numpy API] Returns a single element from this array according to the provided dimension indices. [ILNumerics numpy Module] (Defined by ExtensionMethods.)
	itemT1(Int64, Int64)	Overloaded. [numpy API] Returns a single element from this array according to the provided dimension indices. [ILNumerics numpy Module] (Defined by ExtensionMethods.)
	itemT1(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.)
	itemT1(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.)
	itemT1(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.)
	itemT1(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.)
	itemT1(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.)
	IteratorT1	Efficient iterator over generic type elements for use in foreach loops. [ILNumerics Core Module] (Defined by ExtensionMethods.)
	ravelT1	[numpy API] Returns a flattened copy of the source array. This is the same as flattenT1(BaseArrayT1, StorageOrders). See remarks for details. [ILNumerics numpy Module] (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]

Reference

ILNumerics.Core.Arrays Namespace

ILNumerics.Core.ArraysConcreteRetArrayT1, LocalT, InT, OutT, RetT, StorageT

ConcreteArrayAddLanguageSpecificTextSet("LST52CA2097_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");T1, LocalT, InT, OutT, RetT, StorageTAddLanguageSpecificTextSet("LST52CA2097_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

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