Calculates the eigenvalues and eigenvectors of a symmetric matrix.
This function returns the eigenvalues and, optionally, eigenvectors of a symmetric matrix A of order . It returns an Eigen object containing the vector of values, in ascending order, and, optionally, a matrix holding the vectors.
- Note:
- This function requires BLAS/LAPACK functionality and is only available on machines that provide these libraries. Make sure you enable the SCYTHE_LAPACK preprocessor flag if you wish to use this function. Furthermore, note that this function takes and returns only column-major concrete matrices. Future versions of Scythe will provide a native C++ implementation of this function with support for general matrix templates.
- Parameters:
-
A | The Matrix to be decomposed. |
vectors | This boolean value indicates whether or not to return eigenvectors in addition to eigenvalues. It is set to true by default. |
- Exceptions:
-
- See also:
- Eigen
-
svd(const Matrix<>& A, int nu, int nv);
References scythe::Matrix_base< ORDER, STYLE >::cols(), scythe::Matrix< T_type, ORDER, STYLE >::getArray(), scythe::Matrix_base< ORDER, STYLE >::isNull(), scythe::Matrix_base< ORDER, STYLE >::isSquare(), order(), scythe::Matrix_base< ORDER, STYLE >::rows(), and SCYTHE_CHECK_10.