Public Member Functions | List of all members
Eigen::MatrixSquareRoot< MatrixType, IsComplex > Class Template Reference

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

#include <MatrixSquareRoot.h>

Public Member Functions

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

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
MatrixTypetype 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 313 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]Amatrix 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

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]resultsquare 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:


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:36