Public Member Functions
MatrixSquareRootTriangular< MatrixType > Class Template Reference

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

#include <MatrixSquareRoot.h>

List of all members.

Public Member Functions

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

Detailed Description

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

Class for computing matrix square roots of upper 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 triangular matrix stored in the upper triangular part (including the diagonal) of the matrix passed to the constructor.

See also:
MatrixSquareRoot, MatrixSquareRootQuasiTriangular

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 triangular part (including the diagonal) of result is updated, the rest is not touched. See MatrixBase::sqrt() for details on how this computation is implemented.


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