Class for computing matrix square roots of general matrices. More...

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

Detailed Description

Class for computing matrix square roots of general matrices.

Template Parameters:

MatrixType type of the argument of the matrix square root, expected to be an instantiation of the Matrix class template.

See also:: MatrixSquareRootTriangular, MatrixSquareRootQuasiTriangular, MatrixBase::sqrt()

Definition at line 329 of file MatrixSquareRoot.h.

Constructor & Destructor Documentation

template<typename MatrixType, int IsComplex = NumTraits<typename internal::traits<MatrixType>::Scalar>::IsComplex>

Eigen::MatrixSquareRoot< MatrixType, IsComplex >::MatrixSquareRoot ( const MatrixType & A )

Constructor.

Parameters:

[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.

template<typename MatrixType, int IsComplex = NumTraits<typename internal::traits<MatrixType>::Scalar>::IsComplex>

template<typename ResultType >

void Eigen::MatrixSquareRoot< MatrixType, IsComplex >::compute ( ResultType & result )

Compute the matrix square root.

Parameters:

[out] result square root of A, as specified in the constructor.

See MatrixBase::sqrt() for details on how this computation is implemented.

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