MathWorks.MATLAB.NET.Arrays.native.MWArray Class

Namespace: MathWorks.MATLAB.NET.Arrays.native

Encapsulate native MATLAB mxArray

Description

MWArray is an abstract C# class that serves as the root of the MATLAB^® array class hierarchy. Its derived classes implement MATLAB data types. It encapsulates a native MATLAB mxArray and provides a managed API for accessing, formatting, and manipulating the native array.

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.

Namespace: MathWorks.MATLAB.NET.Arrays.native

Assembly: MWArray (in MWArray.dll) Version: 2.23.1.0 (2.23.1.0)

Syntax:

[SerializableAttribute]
public class MWArray : ICloneable

Properties

Public Properties

ArrayType — Derived type of MWArray

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

positive integer

This property is read-only.

Syntax

public virtual int[] Dimensions { get; }

See size.

IsCellArray — Flag indicating if MWArray is MWCellArray

boolean

This property is read-only.

Syntax

public bool IsCellArray { get; }

See iscell.

IsCharArray — Flag indicating if MWArray is MWCharArray

boolean

This property is read-only.

Syntax

public bool IsCharArray { get; }

See ischar.

IsEmpty — Flag indicating if MWArray is empty

boolean

This property is read-only.

Syntax

public virtual bool IsEmpty { get; }

See isempty.

IsLogicalArray — Flag indicating if MWArray is MWLogicalArray

boolean

This property is read-only.

Syntax

public bool IsLogicalArray { get; }

See islogical.

IsNumericArray — Flag indicating if MWArray is MWNumericArray

boolean

This property is read-only.

Syntax

public bool IsNumericArray { get; }

See isnumeric.

IsStructArray — Flag indicating if MWArray is MWStructArray

boolean

This property is read-only.

Syntax

public bool IsStructArray { get; }

See isstruct.

NumberOfDimensions — Number of dimensions in MWArray

positive integer

This property is read-only.

Syntax

public int NumberofDimensions { get; }

See ndims.

NumberOfElements — Number of elements in MWArray

positive integer

This property is read-only.

Syntax

public int NumberOfElements { get; protected get}

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

Methods

Public Methods

Clone	Syntax public virtual Object Clone() Makes a deep copy of an MWArray See the "=" operator in the MATLAB documentation.
createAxisWeightArray	Syntax protected void createAxisWeightArray()
deepCopy	Syntax protected void deepCopy( MWArraytarget ) Parameters target Type: MathWorks.MATLAB.NET.Arrays.native.MWArray
Equals	Syntax public override bool Equals( Objectobj ) Compares two MWArray instances for equality. Parameters obj Type: System.Object An MWArray referenced as an Object type. Return Value Type: Boolean true if the arrays are equal.
Finalize	(Inherited from Object)
get	Syntax protected Object get( int[] index ) Parameters index Type:System.Int32[] Return Value Type: Object
getDimsStr	Inherited from Object
GetHashCode	Syntax public override int GetHashCode() Return Value Type: Int32 The hashcode for the MWArray.
getOneBasedIndexForArray	Syntax protected int getOneBasedIndexForArray( int[] index ) Parameters index Type: System.Int32[] Return Value Type: Int32
GetType	Inherited from Object
initNativeArray	Syntax protected void initNativeArray( intnum ) Parameters num Type: System.Int32
MemberwiseClone	Inherited from Object
resizeFlatArray	Syntax protected void resizeFlatArray( intnewSize ) Parameters newSize Type: System.Int32
set(Int32,Object)	Syntax protected void set( intindex, Objectval ) Parameters index Type: System.Int32 val Type: System.Object
set(Int32[],Object)	Syntax protected void set( int[] index, Objectval ) Parameters index Type:System.Int32[] val Type: System.Object
setDims	Syntax protected void setDims( int[] inDims ) Parameters inDims Type:System.Int32[]
setFlatArr	Syntax protected void setFlatArr( Object[] newArr ) Parameters newArr Type:System.Object[]
setNumOfElem	Syntax protected void setFlatArr( Object[] newArr ) Parameters inDims Type:System.Int32[]
ToString	Syntax public override string ToString() Return Value Type: String The formatted MWArray string Returns a formatted string representing the contents of the MWArray(Overrides Object.ToString().)

Inheritance Hierarchy

System.Object

• Mathworks.MATLAB.NET.Arrays.native.MWArray

  • Mathworks.MATLAB.NET.Arrays.native.MWCellArray

  • Mathworks.MATLAB.NET.Arrays.native.MWStructArray

Version History

Introduced in R2006a