com.mathworks.toolbox.javabuilder.MWLogicalArray 类

public abstract <T> T applyVisitor(AbstractMWArrayVisitor<T> v)

此方法是抽象的，返回由类型参数<T>指定的类型。它以 AbstractMWArrayVisitor<T> 的一个实例作为参量。此方法的目的是将访问者模式应用于 MWArray 对象。通过使用适当的访问者调用此方法，您可以以类型安全的方式遍历 MWArray 的元素并执行操作。

参数：

返回：

public MWClassID classID()

返回此数组的 MATLAB 类型。

参数：

返回：为 MWClassID.LOGICAL 返回 MWLogicalArray。

示例：获取逻辑数组对象的类 ID

返回 MWLogicalArray 对象 Adata 的类 ID：

boolean[][] Adata = {{true, false, false},
  {false, true, false}};
 
MWLogicalArray A = new MWLogicalArray(Adata);
 
System.out.println("Class of A is " + A.classID());

Class of A is logical

public java.lang.Object clone() throws java.lang.CloneNotSupportedException

创建并返回此数组的深层副本。更改深层复制中的数据不会改变原始数组。

示例：克隆逻辑数组对象

创建 MWLogicalArray 对象 A 的克隆：

boolean[][] Adata = {{true, false, false},
 {false, true, false}};
 
MWLogicalArray A = new MWLogicalArray(Adata);
 
Object C = A.clone();
 
System.out.println("Clone of logical matrix A is:");
System.out.println(C.toString());

Clone of logical matrix A is:
           1   0   0
           0   1   0

返回：MWLogicalArray 实例表示底层 MATLAB^® 数组的深度复制。

抛出：

public int[] columnIndex()

返回一个数组，包含底层 MATLAB 数组中每个元素的列索引。

由以下指定：columnIndex 类中的 MWArray。

返回：索引数组。

public int compareTo(java.lang.Object obj)

将此数组与指定数组进行比较以确定其顺序。

由以下指定：java.lang.Comparable 类中的 compareTo。

由以下指定：MWArray 类中的 compareTo。

参数：

public static MWArray deserialize(byte[] data)

从序列化数据创建一个新的 MWArray。

参数：

返回：反序列化的 MWArray。

public void dispose()

释放此数组包含的原生 MATLAB 数组。

指定者： Disposable 接口中的 dispose

指定方：MWArray 类中的 dispose

public boolean equals(java.lang.Object obj)

指示其他数组是否与此数组相等。

指定方：MWArray 类中的 equals

抛出：

public java.lang.Object get(int index)

返回此数组中指定从 1 开始的偏移量的元素。

参数：

返回：包含所请求元素的对象。

抛出：

public java.lang.Object get(int[] index)

返回此数组中指定的基于 1 的索引数组处的元素。

参数：

返回：包含所请求元素的对象。

抛出：

public boolean getBoolean(int index)

返回指定偏移量（以 1 为基数）的布尔值。

参数：

返回：所请求元素的值。

抛出：

public boolean getBoolean(int[] index)

返回指定的基于 1 的索引数组处的布尔值。

示例：从逻辑数组获取布尔值

boolean[][] Adata = {{true, false, false},
 {false, true, false}};
 
MWLogicalArray A = new MWLogicalArray(Adata);
 
int[] index = {2, 2};
System.out.println("A(2,2) is " + A.getBoolean(index));

A(2,2) = true

参数：

返回：所请求元素的值。

抛出：

public java.lang.Object getData()

返回一个一维数组，其中包含底层 MATLAB 数组中数据的副本。返回数组的元素按照默认转换规则进行转换。如果底层 MATLAB 数组是复数数值类型，getData 将返回实部。如果底层数组是元胞或结构体数组，则在每个元胞上递归调用 toArray。

由以下指定：MWArray 类中的 getData。

返回：按列顺序存储的元素的一维数组。对于非稀疏数组，返回数组的长度等于 numberOfElements()；对于稀疏数组，返回数组的长度等于 numberOfNonZeros()。

public int[] getDimensions()

返回包含此数组每一维的大小的数组。

由以下指定：MWArray 类中的 getDimensions。

返回：包含每个维度大小的数组。

public int hashCode()

返回此数组的哈希码值。

由以下指定：hashCode 类中的 MWArray。

public boolean isEmpty()

测试此数组是否没有元素。

由以下指定：MWArray 类中的 isEmpty。

返回：如果为空则 true，否则 false

public boolean isSparse()

测试此数组是否稀疏。

由以下指定：MWArray 类中的 isSparse。

返回：如果为空则 true，否则 false

public int maximumNonZeros()

返回稀疏数组的分配容量。如果基础数组是非稀疏的，则此方法返回与 numberOfElements() 相同的值。

由以下指定：MWArray 类中的 maximumNonZeros。

返回：当前分配的稀疏数组中的非零元素的数量。

public static MWLogicalArray newInstance(int[] dims)

构造具有指定维度的逻辑数组。数组的元素全部初始化为 false。

示例：使用 newInstance 构造逻辑数组对象

使用 newInstance 方法构造一个 1×5 的逻辑数组。请注意，Java 数组中的数据必须按列顺序存储，以便它在最终的 MWLogicalArray 对象中按行顺序排列。

boolean[] Adata = { true, true, false, false, true};
int[] dims = {1, 5};
 
MWLogicalArray A = MWLogicalArray.newInstance(dims, Adata);
System.out.println("Array A: " + A.toString());

 Array A: 1 1 0 0 1

参数：

返回：具有指定尺寸的新 MWLogicalArray。

抛出：

public static MWLogicalArray newInstance(int[] dims, java.lang.Object data)

构造具有指定维度的逻辑数组，并使用提供的数据初始化该数组。输入数组必须是一维数组，且数据按列主顺序存储。输入数组的有效类型为：double[]、float[]、byte[]、short[]、int[]、long[]、boolean[]、java.lang.Number 的任何子类的 1-D 数组以及 java.lang.Boolean 的 1-D 数组。如果提供的是数值类型，则每个非零数组元素将转换为 true，否则转换为 false。

参数：

返回：一个具有指定尺寸并使用所提供数据初始化的新 MWLogicalArray。

抛出：

public static MWLogicalArray newSparse(int[] rowindex, int[] colindex, java.lang.Object data, int rows, int cols, int nzmax)

构造具有指定行数和列数、最大非零元素数的稀疏逻辑矩阵，并使用提供的数据初始化数组。行和列索引数组用于构建稀疏数组，使得 S(rowindex(k), columnindex(k)) = rData(k)，并为 nzmax 个非零值分配空间。输入数组的有效类型为：double[]、float[]、byte[]、short[]、int[]、long[]、boolean[]、java.lang.Number 的任何子类的 1-D 数组、java.lang.Boolean 的 1-D 数组和 java.lang.String 的 1-D 数组。

示例：构造稀疏逻辑数组对象

使用 newSparse 方法创建一个逻辑值的稀疏数组：

boolean[] Adata = {true, true, false, false, true};

int[] ri = {1, 1, 1, 1, 1};
int[] ci = {1, 2, 3, 4, 5};
 
MWLogicalArray A = MWLogicalArray.newSparse(ri, ci, Adata);
 
System.out.println(A.toString());

(1,1) 1
(1,2) 1
(1,5) 1

参数：

返回：具有指定大小并使用所提供数据进行初始化的新稀疏 MWLogicalArray。

抛出：

public static MWLogicalArray newSparse(int[] rowindex, int[] colindex, java.lang.Object data, int rows, int cols)

构造具有指定行数和列数的稀疏逻辑矩阵，并使用提供的数据初始化该数组。非零元素的最大数量是根据 rData.length 计算的。行和列索引数组用于构建稀疏数组，使得 S(rowindex(k), columnindex(k)) = rData(k)。输入数组的有效类型为：double[]、float[]、byte[]、short[]、int[]、long[]、boolean[]、java.lang.Number 的任何子类的 1-D 数组、java.lang.Boolean 的 1-D 数组和 java.lang.String 的 1-D 数组。

参数：

返回：具有指定大小并使用所提供数据进行初始化的新稀疏 MWLogicalArray。

抛出：

public static MWLogicalArray newSparse(int[] rowindex, int[] colindex, java.lang.Object data)

构造一个稀疏逻辑矩阵，其行数 = max{rowindex(k)} 且列数 = max{colindex(k)}，并使用提供的数据初始化该数组。非零元素的最大数量是根据 rData.length 计算的。行和列索引数组用于构建稀疏数组，使得 S(rowindex(k), columnindex(k)) = rData(k)。输入数组的有效类型为：double[]、float[]、byte[]、short[]、int[]、long[]、boolean[]、java.lang.Number 的任何子类的 1-D 数组、java.lang.Boolean 的 1-D 数组和 java.lang.String 的 1-D 数组。

参数：

返回：具有指定大小并使用所提供数据进行初始化的新稀疏 MWLogicalArray。

抛出：

public static MWLogicalArray newSparse(int rows, int cols, int nzmax)

构造一个没有非零元素的稀疏逻辑矩阵。

参数：

返回：具有指定大小并使用所提供数据进行初始化的新稀疏 MWLogicalArray。

抛出：

public static MWLogicalArray newSparse(java.lang.Object arr)

根据提供的完整矩阵构造一个稀疏逻辑矩阵。

参数：

返回：使用提供的数据初始化新的稀疏 MWLogicalArray。

抛出：

public int numberOfDimensions()

返回此数组的维数。

由以下指定：MWArray 类中的 numberOfDimensions。

返回：维度数。

public int numberOfElements()

返回此数组中元素的总数。

由以下指定：MWArray 类中的 numberOfElements。

返回：元素的数量。

public int maximumNonZeros()

返回稀疏数组的分配容量。如果基础数组是非稀疏的，则此方法返回与 numberOfElements() 相同的值。

由以下指定：MWArray 类中的 maximumNonZeros。

返回：当前分配的稀疏数组中的非零元素的数量。

protected java.lang.Object readResolve() throws java.io.ObjectStreamException

从字节流加载新数组时由序列化机制调用。此方法验证正确的数组类型。

参数：

返回：返回此对象，指示已验证的数组类型。

抛出：

public int[] rowIndex()

返回一个数组，包含底层 MATLAB 数组中每个元素的行索引。

由以下指定：MWArray 类中的 rowIndex。

返回：索引数组。

public byte[] serialize() throws java.io.IOException

将 MATLAB 数组序列化为字节数组。

返回：序列化的 MATLAB 数组数据。

抛出：

public void set(int[] index, boolean element)

用指定的布尔值替换此数组中指定的基于 1 的索引数组处的元素。

参数：

抛出：

示例：在逻辑数组中设置值

获取并修改 A(2,3) 处的值：

boolean[][] Adata = {{true, false, false},
 {false, true, false}};
 
MWLogicalArray A = new MWLogicalArray(Adata);
 
int[] index = {2, 3};
Object d_out = A.get(index);
System.out.println("Array element A(2,3) is " +
d_out.toString() + "\n");
 
System.out.println("Setting A(2,3) to true\n");
A.set(index, true);
 
d_out = A.get(index);
System.out.println("Array element A(2,3) is " +
d_out.toString() + "\n");

Array element A(2,3) is false
 
Setting A(2,3) to true
 
Array element A(2,3) is true

public void set(int[] index, java.lang.Object element)

用指定元素替换此数组中指定的基于 1 的索引数组处的元素。

由以下指定：set 类中的 MWArray。

参数：

抛出：

public void set(int index, boolean element)

用指定的布尔值替换此数组中指定的基于 1 的偏移量的元素。

参数：

抛出：

public void set(int index, java.lang.Object element)

用指定元素替换此数组中位于指定从 1 开始的偏移量的元素。

参数：

抛出：

public void set(int[] index, java.lang.Object element)

用指定元素替换此数组中指定的基于 1 的索引数组处的元素。

由以下指定：set 类中的 MWArray。

参数：

抛出：

public void setData(java.lang.Object data)

由以下指定：setData 类中的 MWArray。

public java.lang.Object sharedCopy()

创建并返回此数组的一个共享副本。共享副本指向与原始数组相同的底层 MATLAB 数组。更改共享副本中的数据也会更改原始数组。

返回：一个 MWLogicalArray 实例，表示底层 MATLAB 数组的共享副本。

示例：制作逻辑数组对象的共享副本

创建 MWLogicalArray 对象 A 的共享副本：

boolean[][] Adata = {{true, false, false},
 {false, true, false}};
 
MWLogicalArray A = new MWLogicalArray(Adata);
 
Object C = A.sharedCopy();
 
System.out.println("Shared copy of logical matrix A is:");
System.out.println(C.toString());

Shared copy of logical matrix A is:
          1   0   0
          0   1   0

public java.lang.Object[] toArray()

返回一个包含底层 MATLAB 数组中数据副本的数组。返回的数组具有与底层 MATLAB 数组相同的维度。返回数组的元素按照默认转换规则进行转换。如果底层 MATLAB 数组是复数数值类型，toArray 将返回实部。如果底层数组是稀疏的，则返回数组的完整表示。在具有较大行和列维度的稀疏数组上调用 toArray 时应小心，因为此操作可能会耗尽系统内存。如果底层数组是元胞或结构体数组，则在每个元胞上递归调用 toArray。

由以下指定：toArray 类中的 MWArray。

返回：与 MATLAB 数组具有相同维数的数组。

public java.lang.String toString()

返回此数组的字符串表示形式。

由以下指定：toString 类中的 MWArray。

protected void validate()

验证内部数组句柄。由构造函数和反序列化代码调用。

public static void disposeArray(java.lang.Object obj)

此方法会销毁输入对象中包含的任何原生 MATLAB 数组并释放它们占用的内存。这是类的静态方法，因此不需要引用类的实例来调用。如果输入对象实现了 Disposable 接口，则通过调用其 Disposable.dispose() 方法来释放该对象。如果输入对象代表 Disposable 实例数组，则数组中的每个对象都会被处置。如果输入对象表示 java.lang.Object 数组或多维数组，则会递归处理该数组以释放数组中包含的每个 Disposable 实例。

示例：构造 MWNumericArray 对象

MWArray[] MArr = new MWArray[10];
for (int i = 0; i < 10; i++)
    MArr[i] = new MWNumericArray();
MWArray.disposeArray(MArr);

参数：

finalize()

当垃圾回收确定没有更多对此对象的引用时，由垃圾回收器对该对象调用。

public final Class<?> getClass()

返回此对象的运行时类。

public final void notify()

public final void notifyAll()

唤醒正在等待此对象的监视器的所有线程。

public final void wait(long timeout, int nanos) throws InterruptedException

使当前线程等待，直到另一个线程调用此对象的 notify() 方法或 notifyAll() 方法，或者某个其他线程中断当前线程，或者已经过了一定的实际时间。