W3cubDocs

/Eigen3

Eigen::MatrixSquareRootReturnValue

template<typename Derived>
class Eigen::MatrixSquareRootReturnValue< Derived >

Proxy for the matrix square root of some matrix (expression).

Template Parameters
Derived Type of the argument to the matrix square root.

This class holds the argument to the matrix square root until it is assigned or evaluated for some other reason (so the argument should not be changed in the meantime). It is the return type of MatrixBase::sqrt() and most of the time this is the only way it is used.

Inherits ReturnByValue< MatrixSquareRootReturnValue< Derived > >.

template<typename ResultType >
void evalTo (ResultType &result) const
Compute the matrix square root. More...
MatrixSquareRootReturnValue (const Derived &src)
Constructor. More...

MatrixSquareRootReturnValue()

template<typename Derived >
Eigen::MatrixSquareRootReturnValue< Derived >::MatrixSquareRootReturnValue ( const Derived & src )
inlineexplicit

Constructor.

Parameters
[in] src Matrix (expression) forming the argument of the matrix square root.

evalTo()

template<typename Derived >
template<typename ResultType >
void Eigen::MatrixSquareRootReturnValue< Derived >::evalTo ( ResultType & result ) const
inline

Compute the matrix square root.

Parameters
[out] result the matrix square root of src in the constructor.
The documentation for this class was generated from the following file:

© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/unsupported/classEigen_1_1MatrixSquareRootReturnValue.html