Eigen::MatrixSquareRootReturnValue< Derived > Class Template Reference

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

#include <ForwardDeclarations.h>

Inheritance diagram for Eigen::MatrixSquareRootReturnValue< Derived >:

Public Member Functions
Index	cols () const
template<typename ResultType >
void	evalTo (ResultType &result) const
	Compute the matrix square root. More...
	MatrixSquareRootReturnValue (const Derived &src)
	Constructor. More...
Index	rows () const
Public Member Functions inherited from Eigen::ReturnByValue< MatrixSquareRootReturnValue< Derived > >
const Unusable &	coeff (Index) const
const Unusable &	coeff (Index, Index) const
Unusable &	coeffRef (Index)
Unusable &	coeffRef (Index, Index)
EIGEN_DEVICE_FUNC Index	cols () const
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
EIGEN_DEVICE_FUNC Index	rows () const

Protected Types
typedef internal::ref_selector< Derived >::type	DerivedNested
typedef Derived::Index	Index

Protected Attributes
const DerivedNested	m_src

Additional Inherited Members
Public Types inherited from Eigen::ReturnByValue< MatrixSquareRootReturnValue< Derived > >
typedef internal::dense_xpr_base< ReturnByValue >::type	Base
typedef internal::traits< MatrixSquareRootReturnValue< Derived > >::ReturnType	ReturnType

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.

Definition at line 286 of file ForwardDeclarations.h.

Member Typedef Documentation

template<typename Derived>

typedef internal::ref_selector<Derived>::type Eigen::MatrixSquareRootReturnValue< Derived >::DerivedNested

protected

Definition at line 322 of file MatrixSquareRoot.h.

template<typename Derived>

typedef Derived::Index Eigen::MatrixSquareRootReturnValue< Derived >::Index

protected

Definition at line 321 of file MatrixSquareRoot.h.

Constructor & Destructor Documentation

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.

Definition at line 330 of file MatrixSquareRoot.h.

Member Function Documentation

template<typename Derived>

Index Eigen::MatrixSquareRootReturnValue< Derived >::cols ( void  ) const

inline

Definition at line 347 of file MatrixSquareRoot.h.

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.

Definition at line 338 of file MatrixSquareRoot.h.

template<typename Derived>

Index Eigen::MatrixSquareRootReturnValue< Derived >::rows ( void  ) const

inline

Definition at line 346 of file MatrixSquareRoot.h.

Member Data Documentation

template<typename Derived>

const DerivedNested Eigen::MatrixSquareRootReturnValue< Derived >::m_src

protected

Definition at line 350 of file MatrixSquareRoot.h.

---

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

• ForwardDeclarations.h
• MatrixSquareRoot.h