MathWorks.MATLAB.NET.Arrays.MWIndexArray Class

Namespace: MathWorks.MATLAB.NET.Arrays

Root for MWArray indexing classes

Description

MWIndexArray is an abstract class that serves as the root for the MWArray indexing classes. These classes, represent array types that can be used as input parameters to the array indexing operator [].

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Properties

Public Properties

ArrayType — Derived type of MWArray

Read-only: MWArrayType

This property is read-only.

Syntax

public MWArrayType ArrayType { get; }

The derived type of the array, specified as an MWArrayType object.

Dimensions — Return native integer array containing size of each dimension of MWArray

Read-only: positive integer

This property is read-only.

Syntax

public virtual int[] Dimensions { get; }

See size.

IsCellArray — Flag indicating if MWArray is MWCellArray

Read-only: boolean

This property is read-only.

Syntax

public bool IsCellArray { get; }

See iscell.

IsCharArray — Flag indicating if MWArray is MWCharArray

Read-only: boolean

This property is read-only.

Syntax

public bool IsCharArray { get; }

See ischar.

IsDisposed — Handle status of encapsulated MWArray

Read-only: boolean

This property is read-only.

Syntax

public virtual bool IsDisposed { get; }

IsEmpty — Flag indicating if MWArray is empty

Read-only: boolean

This property is read-only.

Syntax

public virtual bool IsEmpty { get; }

See isempty.

IsLogicalArray — Flag indicating if MWArray is MWLogicalArray

Read-only: boolean

This property is read-only.

Syntax

public bool IsLogicalArray { get; }

See islogical.

IsNumericArray — Flag indicating if MWArray is MWNumericArray

Read-only: boolean

This property is read-only.

Syntax

public bool IsNumericArray { get; }

See isnumeric.

IsStringArray — Flag indicating if MWArray is MWStringArray

Read-only: boolean

This property is read-only.

Syntax

public bool IsStringArray { get; }

See isstring.

IsStructArray — Flag indicating if MWArray is MWStructArray

Read-only: boolean

This property is read-only.

Syntax

public bool IsStructArray { get; }

See isstruct.

Item — Generic MATLAB indexer returning result as MWArray

MWArray

Syntax

public MWArray this[
	params int[] indices
] { get; set; }

An index can be any number of integers corresponding to the array's dimensions. As with MATLAB, a single index will return the nth element in the array. NOTE: The generic array indexer supports numeric, logical, char, and cell array types. For complex numeric arrays, both the real and the imaginary components are returned.

Array indexing in this API, as in MATLAB^®, is one-based rather than zero-based.

NonZeroMaxStorage — Return number of storage locations allocated for nonzero elements of sparse matrix

Int32

Syntax

public int NonZeroMaxStorage { get; }

For a full matrix, NZMAX(S) is equivalent to prod(size(S)). See nzmax function in the MATLAB documentation.

NumberOfDimensions — Number of dimensions in MWArray

Read-only: positive integer

This property is read-only.

Syntax

public int NumberofDimensions { get; }

See ndims.

NumberOfElements — Number of elements in MWArray

Read-only: positive integer

This property is read-only.

Syntax

public int NumberOfElements { get; }

Equivalent to prod(size(A)) for non-empty arrays. See numel.

Methods

Constructors

These methods specialize standard MATLAB operators and functions for objects in this class.

MWIndexArray()	Syntax protected MWIndexArray() Internal default constructor
MWIndexArray(SerializationInfo, StreamingContext)	Syntax protected MWIndexArray( SerializationInfo serializationInfo, StreamingContext context ) Parameters serializationInfo Type: System.Runtime.Serialization.SerializationInfo Holds the data needed to serialize or deserialize the object. context Type: System.Runtime.Serialization.StreamingContext Describes the source and destination of the serialized stream The arguments for this constructor are supplied by the .NET serialization infrastructure.

Public Methods

Clone	Syntax public virtual ObjectClone() Makes a deep copy of an MWIndexArray. See the "=" operator in the MATLAB documentation.
Dispose()	Syntax public void Dispose() Releases resources of the MWIndexArray and the native MWIndexArray that it encapsulates. This method allows for the explicit lifecycle control of an MWIndexArray and its native MATLAB array.
Dispose(Boolean)	Syntax protected override void Dispose( bool disposing ) Parameters disposing Type: System.Boolean Client explicit dispose flag Internal dispose function
Equals	Syntax public override bool Equals( Objectobj ) Compares two MWIndexArray instances for equality. Returns true if both arrays are equal.
Finalize	Inherited from Object
GetHashCode	Syntax public override int GetHashCode() Returns the hashcode of the MWArray.
GetObjectData	Syntax public virtual void GetObjectData( SerializationInfoinfo, StreamingContextcontext ) Parameters info Type: System.Runtime.Serialization.SerializationInfo Holds the data needed to serialize or deserialize the object. context Type: System.Runtime.Serialization.StreamingContext Describes the source and destination of the serialized stream. Implements ISerializable.GetObjectData(SerializationInfo, StreamingContext) Serialization function. The arguments for this function are supplied by the .NET serialization infrastructure.
GetType	Inherited from Object
MemberwiseClone	Inherited from Object
ToArray	Syntax public virtual Array ToArray() Returns a native .NET array containing a copy of data in the underlying MATLAB array. The returned array has the same dimensionality as the underlying MATLAB array. The elements of the returned array are converted according to default conversion rules. If the underlying MATLAB array is a complex numeric type, toArray throws an exception. If the underlying array is sparse, a full representation of the array is returned. Care should be taken when calling toArray on a sparse array with large row and column dimensions, as this action may exhaust system memory. If the underlying array is a cell or struct array, toArray is recursively called on each cell.
ToString	Syntax public virtual Array ToArray() Returns a native string representing the MATLAB index array (Overrides MWArray.ToString())

Specialized Operators and Functions

These methods specialize standard MATLAB operators and functions for objects in this class.

Implicit(Byte[] to MWIndexArray)	Implicit cast from a native byte array to a MATLAB index array.
Implicit(Int16 to MWIndexArray)	Implicit cast from a native short array to a MATLAB index array.
Implicit(Int32 to MWIndexArray)	Implicit cast from an integer to a MATLAB index array.
Implicit(Int32[] to MWIndexArray)	Implicit cast from a native integer array to a MATLAB index array.
Implicit(Int64[] to MWIndexArray)	Implicit cast from a native long array to a MATLAB index array.

Inheritance Hierarchy

System.Object

• Mathworks.MATLAB.NET.Arrays.MWArray

  • Mathworks.MATLAB.NET.Arrays.MWCellArray

  • Mathworks.MATLAB.NET.Arrays.MWCharArray

  • Mathworks.MATLAB.NET.Arrays.MWIndexArray

  • Mathworks.MATLAB.NET.Arrays.MWObjectArray

  • Mathworks.MATLAB.NET.Arrays.MWStringArray

  • Mathworks.MATLAB.NET.Arrays.MWStructArray

Version History

Introduced in R2006a