MathWorks.MATLAB.NET.Arrays.MWArray Class
Namespace: MathWorks.MATLAB.NET.Arrays
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.
Properties
Public Properties
ArrayType
— Derived type of MWArray
MWArrayType
This property is read-only.
Syntax
public MWArrayType ArrayType { get; }
MWArrayType
object.
Dimensions
— Return native integer array containing size of each dimension of MWArray
positive integer
IsCellArray
— Flag indicating if MWArray
is MWCellArray
boolean
IsCharArray
— Flag indicating if MWArray
is MWCharArray
boolean
IsDisposed
— Handle status of encapsulated MWArray
boolean
This property is read-only.
Syntax
public virtual bool IsDisposed { get; }
IsEmpty
— Flag indicating if MWArray
is empty
boolean
IsLogicalArray
— Flag indicating if MWArray
is MWLogicalArray
boolean
IsNumericArray
— Flag indicating if MWArray
is MWNumericArray
boolean
IsStringArray
— Flag indicating if MWArray
is MWStringArray
boolean
IsStructArray
— Flag indicating if MWArray
is MWStructArray
boolean
Item
— Generic MATLAB indexer returning result as MWArray
MWArray
Syntax
public MWArray this[
params int[] indices
] { get; set; }
Array indexing in this API, as in MATLAB, is one-based rather than zero-based.
NativeGCBlockSize
— Unmanaged memory block size in bytes
positive integer
This property is read-only.
Syntax
public static long NativeGCBlockSize { get; }
NativeGCEnabled
— Native array GC enabled flag
boolean
Syntax
public static bool NativeGCEnabled { get; set; }
MWArray
class or one of its
derived types that are no longer being referenced. This includes unmanaged memory
allocated through explicit creation of MWArray
types, as well as
implicit instantiation of an MWArray
via an implicit cast.
NumberOfDimensions
— Number of dimensions in MWArray
positive integer
NumberOfElements
— Number of elements in MWArray
positive integer
This property is read-only.
Syntax
public int NumberOfElements { get; }
prod(size(A))
for non-empty arrays. See numel
.
Methods
Public Methods
Clone | Syntax public virtual Object Clone() Makes
a deep copy of an |
ConvertToNativeTypes | Syntax public static Object[] ConvertToNativeTypes( MWArray[] src, Type[] specifiedTypes ) Converts an array of |
Dispose() | Syntax publicvoidDispose() Releases
resources of the |
DisposeArray | Syntax publicstaticvoidDisposeArray(
Object_object
) This dispose method recursively frees the resources of
the |
Equals | Syntax public override bool Equals(
Objectobj
) Compares two |
Finalize | Inherited from |
GetHashCode | Syntax public override int GetHashCode() Returns
the hashcode of the |
GetObjectData | Syntax public virtual void GetObjectData( SerializationInfoinfo, StreamingContextcontext )
Implements ISerializable.GetObjectData(SerializationInfo, StreamingContext) Serialization function. The arguments for this function are supplied by the .NET serialization infrastructure. |
GetType | Inherited from |
MemberwiseClone | Inherited from |
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,
|
ToString | Syntax public virtual string ToString() Returns
a formatted string representing the contents of the
|
Specialized Operators and Functions
These methods specialize standard MATLAB operators and functions for objects in this class.
Implicit(Double to MWArray) | Implicit cast from native double scalar value to
|
Implicit(String to MWArray) | Implicit cast from native character string to
|
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
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)