Public Member Functions | List of all members
MatrixSquareRootQuasiTriangular< MatrixType > Class Template Reference

Class for computing matrix square roots of upper quasi-triangular matrices. More...

#include <MatrixSquareRoot.h>

Public Member Functions

template<typename ResultType >
void compute (ResultType &result)
 Compute the matrix square root.
 
 MatrixSquareRootQuasiTriangular (const MatrixType &A)
 Constructor.
 

Detailed Description

template<typename MatrixType>
class Eigen::MatrixSquareRootQuasiTriangular< MatrixType >

Class for computing matrix square roots of upper quasi-triangular matrices.

Template Parameters
MatrixTypetype of the argument of the matrix square root, expected to be an instantiation of the Matrix class template.

This class computes the square root of the upper quasi-triangular matrix stored in the upper Hessenberg part of the matrix passed to the constructor.

See Also
MatrixSquareRoot, MatrixSquareRootTriangular

Constructor & Destructor Documentation

MatrixSquareRootQuasiTriangular ( const MatrixType &  A)
inline

Constructor.

Parameters
[in]Aupper quasi-triangular 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.

Member Function Documentation

void compute ( ResultType &  result)

Compute the matrix square root.

Parameters
[out]resultsquare root of A, as specified in the constructor.

Only the upper Hessenberg part of result is updated, the rest is not touched. See MatrixBase::sqrt() for details on how this computation is implemented.

References RealSchur< _MatrixType >::matrixT(), and RealSchur< _MatrixType >::matrixU().


The documentation for this class was generated from the following file: