Class for computing matrix square roots of general matrices. More...
#include <MatrixSquareRoot.h>
Public Member Functions | |
template<typename ResultType > | |
void | compute (ResultType &result) |
Compute the matrix square root. More... | |
MatrixSquareRoot (const MatrixType &A) | |
Constructor. More... | |
Class for computing matrix square roots of general matrices.
MatrixType | type of the argument of the matrix square root, expected to be an instantiation of the Matrix class template. |
Definition at line 313 of file MatrixSquareRoot.h.
Eigen::MatrixSquareRoot< MatrixType, IsComplex >::MatrixSquareRoot | ( | const MatrixType & | A | ) |
Constructor.
[in] | A | matrix whose square root is to be computed. |
The class stores a reference to A
, so it should not be changed (or destroyed) before compute() is called.
void Eigen::MatrixSquareRoot< MatrixType, IsComplex >::compute | ( | ResultType & | result | ) |
Compute the matrix square root.
[out] | result | square root of A , as specified in the constructor. |
See MatrixBase::sqrt() for details on how this computation is implemented.