LabVIEW Multicore Analysis and Sparse Matrix Toolkit API Reference

Matrix Logarithm VI

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

Matrix Logarithm VI

Owning Palette: Linear Algebra VIs

Requires: Multicore Analysis and Sparse Matrix Toolkit

Computes the natural logarithm of Input Matrix.

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

Details  

Matrix Logarithm (DBL)

Input Matrix specifies a square matrix. If Input Matrix is empty, this VI sets Matrix Logarithm to an empty matrix.
logarithm option specifies the type of logarithm to return.

0General (default)—Specifies that Input Matrix is regarded as a complex matrix.
1Real—Specifies to return an exact real logarithm when Input Matrix is a non-singular normal matrix and each of the negative eigenvalues occurs an even number of times. When Input Matrix is not normal or one of its eigenvalues occurs an odd number of times, this VI returns Matrix Logarithm as if logarithm option were General.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
Matrix Logarithm returns the natural logarithm of Input Matrix.
error out contains error information. This output provides standard error out functionality.

Matrix Logarithm (SGL)

Input Matrix specifies a square matrix. If Input Matrix is empty, this VI sets Matrix Logarithm to an empty matrix.
logarithm option specifies the type of logarithm to return.

0General (default)—Specifies that Input Matrix is regarded as a complex matrix.
1Real—Specifies to return an exact real logarithm when Input Matrix is a non-singular normal matrix and each of the negative eigenvalues occurs an even number of times. When Input Matrix is not normal or one of its eigenvalues occurs an odd number of times, this VI returns Matrix Logarithm as if logarithm option were General.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
Matrix Logarithm returns the natural logarithm of Input Matrix.
error out contains error information. This output provides standard error out functionality.

Matrix Logarithm (CDB)

Input Matrix specifies a square matrix. If Input Matrix is empty, this VI sets Matrix Logarithm to an empty matrix.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
Matrix Logarithm returns the natural logarithm of Input Matrix.
error out contains error information. This output provides standard error out functionality.

Matrix Logarithm (CSG)

Input Matrix specifies a square matrix. If Input Matrix is empty, this VI sets Matrix Logarithm to an empty matrix.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
Matrix Logarithm returns the natural logarithm of Input Matrix.
error out contains error information. This output provides standard error out functionality.

Matrix Logarithm Details

The following table lists the support characteristics of this VI.

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

Refer to the Details section in the Matrix Logarithm VI for more details about this VI.

Log in to get a better experience