Public Member Functions | Private Attributes
Eigen::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)

Private Attributes

const MatrixType & m_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

Definition at line 264 of file MatrixSquareRoot.h.


Constructor & Destructor Documentation

template<typename MatrixType>
Eigen::MatrixSquareRootTriangular< MatrixType >::MatrixSquareRootTriangular ( const MatrixType &  A) [inline]

Definition at line 267 of file MatrixSquareRoot.h.


Member Function Documentation

template<typename MatrixType >
template<typename ResultType >
void Eigen::MatrixSquareRootTriangular< MatrixType >::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.

Definition at line 290 of file MatrixSquareRoot.h.


Member Data Documentation

template<typename MatrixType>
const MatrixType& Eigen::MatrixSquareRootTriangular< MatrixType >::m_A [private]

Definition at line 285 of file MatrixSquareRoot.h.


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


win_eigen
Author(s): Daniel Stonier
autogenerated on Mon Oct 6 2014 12:27:17