LabVIEW Multicore Analysis and Sparse Matrix Toolkit API Reference

Eigenvalues and Vectors VI

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

Eigenvalues and Vectors VI

Owning Palette: Linear Algebra VIs

Requires: Multicore Analysis and Sparse Matrix Toolkit

Finds the eigenvalues and right eigenvectors of the square Input Matrix.

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

Details  

Eigenvalues and Vectors (DBL)

Input Matrix specifies an n-by-n square matrix, where n is the number of rows and columns of Input Matrix.
matrix type is the type of Input Matrix. A symmetric matrix always has real eigenvectors and eigenvalues.

0General (default)
1Symmetric
output option specifies whether this VI computes eigenvectors and/or eigenvalues.

0Eigenvalues—Specifies to compute eigenvalues only.
1Eigenvalues & Vectors (default)—Specifies to compute eigenvalues and eigenvectors.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
Eigenvalues returns a complex vector of n elements, which contains all of the computed eigenvalues of the Input Matrix. The eigenvalues are all real if matrix type is set to Symmetric.
Eigenvectors returns an n-by-n complex matrix containing all of the computed Eigenvectors of the Input Matrix. The ith column of Eigenvectors is the eigenvector corresponding to the ith component of the vector, Eigenvalues. Each eigenvector is normalized so that its Euclidean norm equals 1. The eigenvectors are all real if matrix type is set to Symmetric. If output option is set to Eigenvalues, this VI returns Eigenvectors as an empty matrix.
error out contains error information. This output provides standard error out functionality.

Eigenvalues and Vectors (SGL)

Input Matrix specifies an n-by-n square matrix, where n is the number of rows and columns of Input Matrix.
matrix type is the type of Input Matrix. A symmetric matrix always has real eigenvectors and eigenvalues.

0General (default)
1Symmetric
output option specifies whether this VI computes eigenvectors and/or eigenvalues.

0Eigenvalues—Specifies to compute eigenvalues only.
1Eigenvalues & Vectors (default)—Specifies to compute eigenvalues and eigenvectors.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
Eigenvalues returns a complex vector of n elements, which contains all of the computed eigenvalues of the Input Matrix. The eigenvalues are all real if matrix type is set to Symmetric.
Eigenvectors returns an n-by-n complex matrix containing all of the computed Eigenvectors of the Input Matrix. The ith column of Eigenvectors is the eigenvector corresponding to the ith component of the vector, Eigenvalues. Each eigenvector is normalized so that its Euclidean norm equals 1. The eigenvectors are all real if matrix type is set to Symmetric. If output option is set to Eigenvalues, this VI returns Eigenvectors as an empty matrix.
error out contains error information. This output provides standard error out functionality.

Eigenvalues and Vectors (CDB)

Input Matrix specifies an n-by-n square matrix, where n is the number of rows and columns of Input Matrix.
matrix type is the type of Input Matrix. A Hermitian matrix always has real eigenvalues.

0General (default)
1Hermitian
output option specifies whether this VI computes eigenvectors and/or eigenvalues.

0Eigenvalues—Specifies to compute eigenvalues only.
1Eigenvalues & Vectors (default)—Specifies to compute eigenvalues and eigenvectors.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
Eigenvalues returns a complex vector of n elements, which contains all of the computed eigenvalues of the Input Matrix. The eigenvalues are all real if matrix type is set to Hermitian.
Eigenvectors returns an n-by-n complex matrix containing all of the computed Eigenvectors of the Input Matrix. The ith column of Eigenvectors is the eigenvector corresponding to the ith component of the vector, Eigenvalues. Each eigenvector is normalized so that its Euclidean norm equals 1. If output option is set to Eigenvalues, this VI returns Eigenvectors as an empty matrix.
error out contains error information. This output provides standard error out functionality.

Eigenvalues and Vectors (CSG)

Input Matrix specifies an n-by-n square matrix, where n is the number of rows and columns of Input Matrix.
matrix type is the type of Input Matrix. A Hermitian matrix always has real eigenvalues.

0General (default)
1Hermitian
output option specifies whether this VI computes eigenvectors and/or eigenvalues.

0Eigenvalues—Specifies to compute eigenvalues only.
1Eigenvalues & Vectors (default)—Specifies to compute eigenvalues and eigenvectors.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
Eigenvalues returns a complex vector of n elements, which contains all of the computed eigenvalues of the Input Matrix. The eigenvalues are all real if matrix type is set to Hermitian.
Eigenvectors returns an n-by-n complex matrix containing all of the computed Eigenvectors of the Input Matrix. The ith column of Eigenvectors is the eigenvector corresponding to the ith component of the vector, Eigenvalues. Each eigenvector is normalized so that its Euclidean norm equals 1. If output option is set to Eigenvalues, this VI returns Eigenvectors as an empty matrix.
error out contains error information. This output provides standard error out functionality.

Eigenvalues and Vectors Details

The following table lists the support characteristics of this VI.

Supported on RT targets Yes
Suitable for bounded execution times on RT Yes (with exceptions). The following cases are exceptions:
  • Eigenvalues and Vectors (DBL) when matrix type is Symmetric
  • Eigenvalues and Vectors (CSG) when matrix type is Hermitian

Refer to the Details section in the Eigenvalues and Vectors VI for more details about this VI.

Log in to get a better experience