LabVIEW Multicore Analysis and Sparse Matrix Toolkit API Reference

Matrix Rank VI

  • Updated2023-02-21
  • 6 minute(s) read

Matrix Rank VI

Owning Palette: Linear Algebra VIs

Requires: Multicore Analysis and Sparse Matrix Toolkit

Computes the rank of Input Matrix.

Wire data to the Input Matrix input to determine the polymorphic instance to use or manually select the instance.

Details  

Matrix Rank (DBL)

Input Matrix specifies a square or rectangular matrix. If Input Matrix is empty, this VI sets rank to -1.
tolerance specifies a level such that this VI treats the singular values of Input Matrix that are smaller than or equal to this level as zeros. The default is –1. If tolerance is negative, this VI specifies tolerance according to the following equation.

tolerance = max(m,n)*||A||*,

where A represents the Input Matrix, ||A|| is the 2-norm of A, m represents the number of rows in A, n represents the number of columns in A, and is a double-precision machine epsilon, as shown in the following relationship.

= 2–52 = 2.22e – 16

error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
rank returns the number of singular values in the Input Matrix that are larger than the tolerance. The rank represents the maximum number of independent rows or columns in the Input Matrix.
error out contains error information. This output provides standard error out functionality.

Matrix Rank (SGL)

Input Matrix specifies a square or rectangular matrix. If Input Matrix is empty, this VI sets rank to -1.
tolerance specifies a level such that this VI treats the singular values of Input Matrix that are smaller than or equal to this level as zeros. The default is –1. If tolerance is negative, this VI specifies tolerance according to the following equation.

tolerance = max(m,n)*||A||*,

where A represents the Input Matrix, ||A|| is the 2-norm of A, m represents the number of rows in A, n represents the number of columns in A, and is a single-precision machine epsilon, as shown in the following relationship.

= 2–23 = 1.19e – 7

error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
rank returns the number of singular values in the Input Matrix that are larger than the tolerance. The rank represents the maximum number of independent rows or columns in the Input Matrix.
error out contains error information. This output provides standard error out functionality.

Matrix Rank (CDB)

Input Matrix specifies a square or rectangular matrix. If Input Matrix is empty, this VI sets rank to -1.
tolerance specifies a level such that this VI treats the singular values of Input Matrix that are smaller than or equal to this level as zeros. The default is –1. If tolerance is negative, this VI specifies tolerance according to the following equation.

tolerance = max(m,n)*||A||*,

where A represents the Input Matrix, ||A|| is the 2-norm of A, m represents the number of rows in A, n represents the number of columns in A, and is a double-precision machine epsilon, as shown in the following relationship.

= 2–52 = 2.22e – 16

error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
rank returns the number of singular values in the Input Matrix that are larger than the tolerance. The rank represents the maximum number of independent rows or columns in the Input Matrix.
error out contains error information. This output provides standard error out functionality.

Matrix Rank (CSG)

Input Matrix specifies a square or rectangular matrix. If Input Matrix is empty, this VI sets rank to -1.
tolerance specifies a level such that this VI treats the singular values of Input Matrix that are smaller than or equal to this level as zeros. The default is –1. If tolerance is negative, this VI specifies tolerance according to the following equation.

tolerance = max(m,n)*||A||*,

where A represents the Input Matrix, ||A|| is the 2-norm of A, m represents the number of rows in A, n represents the number of columns in A, and is a single-precision machine epsilon, as shown in the following relationship.

= 2–23 = 1.19e – 7

error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
rank returns the number of singular values in the Input Matrix that are larger than the tolerance. The rank represents the maximum number of independent rows or columns in the Input Matrix.
error out contains error information. This output provides standard error out functionality.

Matrix Rank Details

The following table lists the support characteristics of this VI.

Supported on RT targets Yes
Suitable for bounded execution times on RT Yes

Log in to get a better experience