MathWorks.MATLAB.NET.Arrays.MWLogicalArray 类

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

MATLAB 逻辑数组的托管表示

全页展开

描述

MWLogicalArray 是 MATLAB 逻辑数组的托管表示。与其 MATLAB 等效项一样，MWLogicalArray 仅包含 1 和 0（真/假）。

由于 MWLogicalArray 源自 MWIndexArray，因此它可以在所有 MATLAB 索引操作中使用。

线程安全

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

属性

全部展开

公共属性

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

此属性为只读。

语法

public MWArrayType ArrayType { get; }

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

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

此属性为只读。

语法

public virtual int[] Dimensions { get; }

请参阅 size。

`Empty` — 返回空的 `MWLogicalArray` 的可写版本
只读: `MWLogicalArray`

此属性为只读。

语法

public static MWLogicalArray Empty { get; }

`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。

`IsScalar` — 如果数组为逻辑标量则返回 true
只读: `boolean`

此属性为只读。

语法

public bool IsScalar { get; }

`IsSparse` — 如果数组为稀疏数组则返回 true
只读: `boolean`

此属性为只读。

语法

public bool IsSparse { get; }

`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 开始的。

`NonZeroMaxStorage` — 返回为稀疏矩阵的非零元素分配的存储位置数
`Int32`

语法

public int NonZeroMaxStorage { get; }

对于满矩阵，NZMAX(S) 等效于 prod(size(S))。请参阅 MATLAB 文档中的 nzmax 函数。

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

此属性为只读。

语法

public int NumberofDimensions { get; }

请参阅 ndims。

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

此属性为只读。

语法

public int NumberOfElements { get; }

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

方法

全部展开

构造函数

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

`MWLogicalArray()`	语法 public MWLogicalArray() 创建一个空的逻辑数组
`MWLogicalArray(Array)`	语法 public MWCharArray( Array stringArray ) 从布尔值原生数组构造一个 m×n×p×... 逻辑数组。参数 boolArray 类型：System.Array 本机布尔数组。逻辑数组将具有与原生数组相同的维度和值。注意：由于 MATLAB 数组必须至少有两个维度，因此单维原生数组将导致创建具有单行的二维逻辑数组。
`MWLogicalArray(Boolean)`	语法 public MWLogicalArray( bool logicalValue ) 创建一个表示指定布尔值的逻辑标量数组。参数 value 类型：System.Boolean 一个布尔值。
`MWLogicalArray(Int32[])`	语法 public MWLogicalArray( params int[] dimensions ) 创建一个 m×n×p×... 的空逻辑数组。参数 value 类型：System.Int32[] 数组维数。如果仅指定一个维度，则会创建一个空的 n×n 逻辑数组。
`MWLogicalArray(Int32, Int32)`	语法 public MWLogicalArray( int row, int column ) 创建一个空的 m×n 逻辑数组。参数 row 类型：System.Int32 数组中的行数 column 类型：System.Int32 数组中的列数
`MWLogicalArray(SerializationInfo, Streaming,Context)`	语法 protected MWLogicalArray( SerializationInfo serializationInfo, StreamingContext context ) 内部反序列化构造函数。参数 serializationInfo 类型：System.Runtime.Serialization.SerializationInfo 保存序列化或反序列化对象所需的数据。 context 类型：System.Runtime.Serialization.StreamingContext 描述序列化流的源和目标
`MWLogicalArray(Int32, Int32, Boolean[])`	语法 public MWLogicalArray( int rows, int columns, bool[] boolArray ) 构造一个 m×n 逻辑数组，并将其初始化为本机布尔数组中包含的值。参数 row 类型：System.Int32 数组中的行数 column 类型：System.Int32 数组中的列数 boolArray 类型：System.Boolean[] 布尔值的原生向量逻辑数组按行主顺序根据布尔向量中包含的值进行初始化。向量数组中的元素数量必须与新创建的逻辑数组中的元素数量（行*列）相匹配。
`MWLogicalArray(Int32, Int32, Boolean[], Boolean)`	语法 public MWLogicalArray( int rows, int columns, bool[] boolArray, bool columnMajorOrder ) 构造一个 m×n 逻辑数组，并将其初始化为本机布尔数组中包含的值。内部反序列化构造函数。参数 row 类型：System.Int32 数组中的行数 column 类型：System.Int32 数组中的列数 boolArray 类型：System.Boolean[] 布尔值的原生向量 columnMajorOrder 类型：System.Boolean 布尔标志 - 如果逻辑数组应按列主顺序初始化，则为 true。逻辑数组按照布尔数组中包含的值的指定顺序进行初始化。数组中元素的数量必须与新创建的逻辑数组中元素的数量（行*列）相匹配。

公共方法

`Clone`	语法 public virtual Object Clone() 对 `MWArray` 进行深度复制。请参阅 MATLAB 文档中的 “=” 运算符。
`ConvertToNativeTypes`	语法 public static Object[] ConvertToNativeTypes( MWArray[] src, Type[] specifiedTypes ) 将 `MWArray` 数组转换为用户指定的类型。如果成功则返回具有转换类型的对象数组，否则抛出 `ArgumentException`。此方法只能从生成的实现中调用。
`Dispose()`	语法 public void Dispose() 释放 `MWArray` 及其封装的本机 `mxArray` 的资源。此方法允许对 `MWArray` 及其原生 MATLAB 数组进行明确的生命周期控制。
`Dispose(Boolean)`	语法 protected override void Dispose( bool disposing ) 参数 disposing 类型：System.Boolean 客户端显式处置标志内部处理函数
`Equals`	语法 public override bool Equals( Objectobj ) 比较两个 `MWArray` 实例是否相等。如果两个数组相等，则返回 true。
`Finalize`	从 `Object` 继承
`GetHashCode`	语法 public override int GetHashCode() 返回 `MWArray` 的哈希码。
`GetObjectData`	语法 public virtual void GetObjectData( SerializationInfo info, StreamingContext context ) 参数 info 类型：System.Runtime.Serialization.SerializationInfo 保存序列化或反序列化对象所需的数据。 context 类型：System.Runtime.Serialization.StreamingContext 描述序列化流的源和目标。实现 ISerializable.GetObjectData(SerializationInfo, StreamingContext) 序列化函数。此函数的参量由 .NET 序列化基础结构提供。
`GetType`	从 `Object` 继承
`MakeSparse(Int32, Int32, Int32)`	语法 public static MWLogicalArray MakeSparse( int rows, int columns, int nonZeroMax ) 参数 Rows 类型：System.Int32 稀疏矩阵的行数 Columns 类型：System.Int32 稀疏矩阵的列数 nonZeroMax 类型：System.Int32 稀疏矩阵中非零元素的最大数量返回值类型：`MWLogicalArray` 稀疏逻辑矩阵构造具有指定行和列以及指定数量非零元素的存储空间的稀疏逻辑矩阵。
`MakeSparse(Int32[],Int32[],Boolean[])`	语法 publicstaticMWLogicalArrayMakeSparse( int[] rowIndex, int[] columnIndex, bool[] dataArray ) 参数 rowIndex 类型：System.Int32[] 从 1 开始的行索引数组 columnIndex 类型：System.Int32[] 基于 1 的列索引数组 dataArray 类型：System.boolean[] 稀疏矩阵的逻辑数据数组返回值类型：`MWLogicalArray` 稀疏逻辑矩阵构造一个逻辑稀疏矩阵，其行数 = max{rowIndex(k)}，列数 = max{colIndex(k)}。它使用提供的数据初始化数组。非零元素的最大数量等于数据数组的长度。行和列索引数组用于构建稀疏数组，使得 S(rowIndex(k), columnIndex(k))= dataArray(k)。
`MakeSparse(Int32, Int32,Int32[],Int32[],Boolean[])`	语法 publicstaticMWLogicalArrayMakeSparse( int[] rowIndex, int[] columnIndex, bool[] dataArray ) 参数 rows 类型：System.Int32 稀疏矩阵的行数 columns 类型：System.Int32 稀疏矩阵的列数 rowIndex 类型：System.Int32[] 从 1 开始的行索引数组 columnIndex 类型：System.Int32[] 基于 1 的列索引数组 dataArray 类型：System.boolean[] 稀疏矩阵的逻辑数据数组返回值类型：`MWLogicalArray` 稀疏逻辑矩阵行和列索引数组用于构建稀疏数组，使得 S(rowIndex(k), columnIndex(k))= dataArray(k)。
`MakeSparse(Int32, Int32,Int32[],Int32[],Boolean[], Int32)`	语法 publicstaticMWLogicalArrayMakeSparse( int[] rowIndex, int[] columnIndex, bool[] dataArray ) 参数 rows 类型：System.Int32 稀疏矩阵的行数 columns 类型：System.Int32 稀疏矩阵的列数 rowIndex 类型：System.Int32[] 从 1 开始的行索引数组 columnIndex 类型：System.Int32[] 基于 1 的列索引数组 dataArray 类型：System.boolean[] 稀疏矩阵的逻辑数据数组 nonZeroMax 类型：System.Int32 稀疏矩阵中非零元素的最大数量返回值类型：`MWLogicalArray` 稀疏逻辑矩阵行和列索引数组用于构建稀疏数组，使得 S(rowIndex(k), columnIndex(k))= dataArray(k)。
`MemberwiseClone`	从 `Object` 继承
`ToArray`	语法 public virtual Array ToArray() 返回一个本机 .NET 数组，其中包含底层 MATLAB 数组中的数据副本。返回的数组具有与底层 MATLAB 数组相同的维度。返回数组的元素按照默认转换规则进行转换。如果底层 MATLAB 数组是复数数值类型，`toArray` 将引发异常。如果底层数组是稀疏的，则返回数组的完整表示。在具有较大行和列维度的稀疏数组上调用 `toArray` 时应小心，因为此操作可能会耗尽系统内存。如果底层数组是元胞或结构体数组，则在每个元胞上递归调用 `toArray`。
`ToString`	语法 public virtual string ToString() 返回代表 `MWArray` 内容的格式化字符串
`ToVector`	语法 public bool[] ToVector() 以一维原生布尔数组的形式返回逻辑数组中元素的副本数据以标准 MATLAB 列主顺序（而不是 C# 行主顺序）的原生数组形式返回。

特殊运算符和函数

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

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

继承层次结构

System.Object

Mathworks.MATLAB.NET.Arrays.MWArray
- Mathworks.MATLAB.NET.Arrays.MWIndexArray
  - Mathworks.MATLAB.NET.Arrays.MWLogicalArray
  - Mathworks.MATLAB.NET.Arrays.MWNumericArray

版本历史记录

在 R2006a 中推出

MathWorks.MATLAB.NET.Arrays.MWLogicalArray 类

描述

属性

公共属性

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

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

Empty — 返回空的 MWLogicalArray 的可写版本 只读: MWLogicalArray

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

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

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

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

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

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

IsScalar — 如果数组为逻辑标量则返回 true 只读: boolean

IsSparse — 如果数组为稀疏数组则返回 true 只读: boolean

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

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

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

NonZeroMaxStorage — 返回为稀疏矩阵的非零元素分配的存储位置数 Int32

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

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

方法

构造函数

公共方法

特殊运算符和函数

继承层次结构

版本历史记录

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

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

`Empty` — 返回空的 `MWLogicalArray` 的可写版本
只读: `MWLogicalArray`

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

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

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

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

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

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

`IsScalar` — 如果数组为逻辑标量则返回 true
只读: `boolean`

`IsSparse` — 如果数组为稀疏数组则返回 true
只读: `boolean`

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

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

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

`NonZeroMaxStorage` — 返回为稀疏矩阵的非零元素分配的存储位置数
`Int32`

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

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