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

MatrixSquareRootReturnValue< Derived > Class Template Reference
[Matrix functions module]

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

Inherits ReturnByValue< MatrixSquareRootReturnValue< Derived > >.

List of all members.

Public Member Functions

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

Detailed Description

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.


Constructor & Destructor Documentation

MatrixSquareRootReturnValue ( const Derived &  src  )  [inline]

Constructor.

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

Member Function Documentation

void 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: