$treeview $search $mathjax
$projectbrief
$projectbrief
$searchbox

MatrixSquareRoot< MatrixType, IsComplex > Class Template Reference
[Matrix functions module]

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

List of all members.

Public Member Functions

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

Detailed Description

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

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()

Constructor & Destructor Documentation

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.


Member Function Documentation

void compute ( ResultType &  result  )  [inline]

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: