tmath::MatrixEigenSym Class Reference
Eigen decomposition of symmetric matrices. More...
#include <matrix_eigen.hpp>
Collaboration diagram for tmath::MatrixEigenSym:
Public Types | |
|
typedef Eigen::Matrix< TScalar, Eigen::Dynamic, Eigen::Dynamic, Eigen::ColMajor > | Base |
|
typedef Eigen::Matrix< TScalar, Eigen::Dynamic, Eigen::Dynamic, Eigen::ColMajor > | Base2 |
| typedef int | TIndex |
| typedef double | TScalar |
|
typedef Eigen::SelfAdjointEigenSolver < Base2 > | TSolver |
Public Member Functions | |
| Matrix | __pow__ (const TScalar &exponent) const |
| operator ^(scalar) in scripting languages by SWIG | |
| Matrix | Eigenvalues () const |
| returns the eigenvalues as vector | |
| Matrix | Eigenvectors () const |
| returns the normalized complex eigenvectors as a matrix of column vectors. | |
| bool | EigenvectorsAvailable () const |
| returns m_eigenvectorsAvailable | |
| Matrix | Exp () const |
| returns the exponential of the matrix | |
| bool | IsGeneralEigenproblem () const |
| returns m_isGeneralEigenproblem | |
| Matrix | Log () const |
| returns the logarithm of the matrix | |
| MatrixEigenSym (Matrix &_object, Matrix &mass, const bool &computevectors=true) | |
| MatrixEigenSym (Matrix &_object, const bool &computevectors=true) | |
| constructor | |
| Matrix | OperatorInverseSqrt () const |
| returns the positive inverse square root of the matrix (if positive definite) | |
| Matrix | OperatorSqrt () const |
| returns the positive square root of the matrix (if positive definite) | |
| Matrix | Pow (const TScalar &exponent) const |
| returns the power of the matrix | |
| virtual | ~MatrixEigenSym () |
| destructor | |
Protected Member Functions | |
|
Eigen::SelfAdjointEigenSolver < Base2 > & | eigen () |
| returns the lu object this class refers to | |
|
const Eigen::SelfAdjointEigenSolver < Base2 > & | eigen () const |
| returns the lu object this class refers to | |
| Matrix & | object () |
| returns the matrix object this class refers to | |
| const Matrix & | object () const |
| returns the matrix object this class refers to | |
Protected Attributes | |
| TSolver * | m_eigen |
| the LU object | |
| bool | m_eigenvectorsAvailable |
| is true if the eigenvectors were computed | |
| bool | m_isGeneralEigenproblem |
| is true if the eigen problem is a general eigen problem | |
| Matrix * | m_object |
| the matrix object this class is operating on | |
Detailed Description
Eigen decomposition of symmetric matrices.This class provides an Eigen decomposition of symmetric matrices. At construction, it factorizes the given matrix and stores eigenvalues and (if asked for) eigenvectors. The constructor accepts either the standard eigenvalues problem (of a single symmetric matrix) or the generalized eigenvalue problem (of 2 symmetric matrices).
The class is equipped with methods and arithmetic operators which provide the
- matrix exponential
- matrix power
- matrix logarithm
- matrix square root using the full decomposition.
The documentation for this class was generated from the following file:
- modules/tmath/tmath/dense/matrix_eigen.hpp
