MathWorks.MATLAB.NET.Arrays.MWArray 类

命名空间: MathWorks.MATLAB.NET.Arrays

封装原生 MATLAB mxArray

全页展开

描述

MWArray 是一个抽象的 C# 类，是 MATLAB^® 数组类层次结构的根。其派生类实现 MATLAB 数据类型。它封装了本机 MATLAB mxArray 并提供用于访问、格式化和操作原生数组的托管 API。

线程安全

此类型的任何公共静态（在 Visual Basic 中为共享）成员都是线程安全的。任何实例成员都不能保证是线程安全的。

属性

全部展开

公共属性

`ArrayType` — `MWArray` 的派生类型
只读: `MWArrayType`

此属性为只读。

语法

public MWArrayType ArrayType { get; }

数组的派生类型，指定为 MWArrayType 对象。

`Dimensions` — 返回包含 `MWArray` 各维大小的本机整数数组
只读: 正整数

此属性为只读。

语法

public virtual int[] Dimensions { get; }

请参阅 size。

`IsCellArray` — 指示 `MWArray` 是否为 `MWCellArray` 的标志
只读: `boolean`

此属性为只读。

语法

public bool IsCellArray { get; }

请参阅 iscell。

`IsCharArray` — 指示 `MWArray` 是否为 `MWCharArray` 的标志
只读: `boolean`

此属性为只读。

语法

public bool IsCharArray { get; }

请参阅 ischar。

`IsDisposed` — 处理封装的 `MWArray` 的状态
只读: `boolean`

此属性为只读。

语法

public virtual bool IsDisposed { get; }

`IsEmpty` — 指示 `MWArray` 是否为空的标志
只读: `boolean`

此属性为只读。

语法

public virtual bool IsEmpty { get; }

请参阅 isempty。

`IsLogicalArray` — 指示 `MWArray` 是否为 `MWLogicalArray` 的标志
只读: `boolean`

此属性为只读。

语法

public bool IsLogicalArray { get; }

请参阅 islogical。

`IsNumericArray` — 指示 `MWArray` 是否为 `MWNumericArray` 的标志
只读: `boolean`

此属性为只读。

语法

public bool IsNumericArray { get; }

请参阅 isnumeric。

`IsStringArray` — 指示 `MWArray` 是否为 `MWStringArray` 的标志
只读: `boolean`

此属性为只读。

语法

public bool IsStringArray { get; }

请参阅 isstring。

`IsStructArray` — 指示 `MWArray` 是否为 `MWStructArray` 的标志
只读: `boolean`

此属性为只读。

语法

public bool IsStructArray { get; }

请参阅 isstruct。

`Item` — 通用 MATLAB 索引器以 `MWArray` 形式返回结果
`MWArray`

语法

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

索引可以是与数组维度相对应的任意数量的整数。与 MATLAB 一样，单个索引将返回数组中的第 n 个元素。注意：通用数组索引器支持数字、逻辑、字符和元胞数组类型。对于复杂的数字数组，将返回实部和虚组件。

与 MATLAB 一样，此 API 中的数组索引是从 1 开始的，而不是从 0 开始的。

`NativeGCBlockSize` — 非托管内存模块大小（以字节为单位）
只读: 正整数

此属性为只读。

语法

public static long NativeGCBlockSize { get; }

`NativeGCEnabled` — 原生数组 GC 启用标志
`boolean`

语法

public static bool NativeGCEnabled { get; set; }

如果启用了原生数组 GC，则 CLR 垃圾收集将根据需要透明地进行，以删除不再被引用的 MWArray 类或其派生类型的实例。这包括通过显式创建 MWArray 类型分配的非托管内存，以及通过隐式转换隐式实例化 MWArray。

`NumberOfDimensions` — `MWArray` 中的维数
只读: 正整数

此属性为只读。

语法

public int NumberofDimensions { get; }

请参阅 ndims。

`NumberOfElements` — `MWArray` 中的元素数量
只读: 正整数

此属性为只读。

语法

public int NumberOfElements { get; }

对于非空数组，等效于 prod(size(A))。请参阅 numel。

方法

全部展开

公共方法

`Clone`	语法 public virtual Object Clone() 对 `MWArray` 进行深度复制。请参阅 MATLAB 文档中的 “=” 运算符。
`ConvertToNativeTypes`	语法 public static Object[] ConvertToNativeTypes( MWArray[] src, Type[] specifiedTypes ) 将 `MWArray` 数组转换为用户指定的类型。如果成功则返回具有转换类型的对象数组，否则抛出 `ArgumentException`。此方法只能从生成的实现中调用。
`Dispose()`	语法 publicvoidDispose() 释放 `MWArray` 及其封装的本机 `mxArray` 的资源。此方法允许对 `MWArray` 及其原生 MATLAB 数组进行明确的生命周期控制。
`DisposeArray`	语法 publicstaticvoidDisposeArray( Object_object ) 此 dispose 方法递归释放 Object 参量中包含的 `MWArray` 实例的资源。如果对象实现了 `IDisposable` 接口，则可以通过调用其 Dispose 方法来释放它。如果该对象表示实现 `IDisposable` 接口的对象数组，则数组中的每个对象都通过 dispose 方法释放。最后，如果该对象表示一个多维数组，则递归处理该数组以释放数组中包含的每个对象。
`Equals`	语法 public override bool Equals( Objectobj ) 比较两个 `MWArray` 实例是否相等。如果两个数组相等，则返回 true。
`Finalize`	从 `Object` 继承
`GetHashCode`	语法 public override int GetHashCode() 返回 `MWArray` 的哈希码。
`GetObjectData`	语法 public virtual void GetObjectData( SerializationInfoinfo, StreamingContextcontext ) 参数 info 类型：System.Runtime.Serialization.SerializationInfo 保存序列化或反序列化对象所需的数据。 context 类型：System.Runtime.Serialization.StreamingContext 描述序列化流的源和目标。实现 ISerializable.GetObjectData(SerializationInfo, StreamingContext) 序列化函数。此函数的参量由 .NET 序列化基础结构提供。
`GetType`	从 `Object` 继承
`MemberwiseClone`	从 `Object` 继承
`ToArray`	语法 public virtual Array ToArray() 返回一个本机 .NET 数组，其中包含底层 MATLAB 数组中的数据副本。返回的数组具有与底层 MATLAB 数组相同的维度。返回数组的元素按照默认转换规则进行转换。如果底层 MATLAB 数组是复数数值类型，`toArray` 将引发异常。如果底层数组是稀疏的，则返回数组的完整表示。在具有较大行和列维度的稀疏数组上调用 `toArray` 时应小心，因为此操作可能会耗尽系统内存。如果底层数组是元胞或结构体数组，则在每个元胞上递归调用 `toArray`。
`ToString`	语法 public virtual string ToString() 返回代表 `MWArray` 内容的格式化字符串

特殊运算符和函数

这些方法专门针对此类中的对象提供标准 MATLAB 运算符和函数。

`Implicit(Double to MWArray)`	从本机双精度标量值隐式转换为 `MWNumericArray`
`Implicit(String to MWArray)`	从本机字符串隐式转换为 `MWCharArray`

继承层次结构

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

版本历史记录

在 R2006a 中推出

MathWorks.MATLAB.NET.Arrays.MWArray 类

描述

属性

公共属性

ArrayType — MWArray 的派生类型 只读: MWArrayType

Dimensions — 返回包含 MWArray 各维大小的本机整数数组 只读: 正整数

IsCellArray — 指示 MWArray 是否为 MWCellArray 的标志 只读: boolean

IsCharArray — 指示 MWArray 是否为 MWCharArray 的标志 只读: boolean

IsDisposed — 处理封装的 MWArray 的状态 只读: boolean

IsEmpty — 指示 MWArray 是否为空的标志 只读: boolean

IsLogicalArray — 指示 MWArray 是否为 MWLogicalArray 的标志 只读: boolean

IsNumericArray — 指示 MWArray 是否为 MWNumericArray 的标志 只读: boolean

IsStringArray — 指示 MWArray 是否为 MWStringArray 的标志 只读: boolean

IsStructArray — 指示 MWArray 是否为 MWStructArray 的标志 只读: boolean

Item — 通用 MATLAB 索引器以 MWArray 形式返回结果 MWArray

NativeGCBlockSize — 非托管内存模块大小（以字节为单位） 只读: 正整数

NativeGCEnabled — 原生数组 GC 启用标志 boolean

NumberOfDimensions — MWArray 中的维数 只读: 正整数

NumberOfElements — MWArray 中的元素数量 只读: 正整数

方法

公共方法

特殊运算符和函数

继承层次结构

版本历史记录

`ArrayType` — `MWArray` 的派生类型
只读: `MWArrayType`

`Dimensions` — 返回包含 `MWArray` 各维大小的本机整数数组
只读: 正整数

`IsCellArray` — 指示 `MWArray` 是否为 `MWCellArray` 的标志
只读: `boolean`

`IsCharArray` — 指示 `MWArray` 是否为 `MWCharArray` 的标志
只读: `boolean`

`IsDisposed` — 处理封装的 `MWArray` 的状态
只读: `boolean`

`IsEmpty` — 指示 `MWArray` 是否为空的标志
只读: `boolean`

`IsLogicalArray` — 指示 `MWArray` 是否为 `MWLogicalArray` 的标志
只读: `boolean`

`IsNumericArray` — 指示 `MWArray` 是否为 `MWNumericArray` 的标志
只读: `boolean`

`IsStringArray` — 指示 `MWArray` 是否为 `MWStringArray` 的标志
只读: `boolean`

`IsStructArray` — 指示 `MWArray` 是否为 `MWStructArray` 的标志
只读: `boolean`

`Item` — 通用 MATLAB 索引器以 `MWArray` 形式返回结果
`MWArray`

`NativeGCBlockSize` — 非托管内存模块大小（以字节为单位）
只读: 正整数

`NativeGCEnabled` — 原生数组 GC 启用标志
`boolean`

`NumberOfDimensions` — `MWArray` 中的维数
只读: 正整数

`NumberOfElements` — `MWArray` 中的元素数量
只读: 正整数