Public Member Functions | Protected Attributes
MatrixSquareRootReturnValue< Derived > Class Template Reference

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

#include <MatrixSquareRoot.h>

List of all members.

Public Member Functions

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

Protected Attributes

const Derived & m_src

Detailed Description

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

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

Template Parameters:
DerivedType 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]srcMatrix (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]resultthe matrix square root of src in the constructor.

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