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

#include <MatrixSquareRoot.h>

Inheritance diagram for Eigen::MatrixSquareRootReturnValue< Derived >:

Public Member Functions
	MatrixSquareRootReturnValue (const Derived &src)
	Constructor. More...

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

Index	rows () const

Index	cols () const

Public Member Functions inherited from Eigen::ReturnByValue< MatrixSquareRootReturnValue< Derived > >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const

EIGEN_DEVICE_FUNC Index	rows () const

EIGEN_DEVICE_FUNC Index	cols () const

const Unusable &	coeff (Index) const

const Unusable &	coeff (Index, Index) const

Unusable &	coeffRef (Index)

Unusable &	coeffRef (Index, Index)

Protected Types
typedef Derived::Index	Index

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

Protected Attributes
const DerivedNested	m_src

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

typedef internal::dense_xpr_base< ReturnByValue >::type	Base

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()

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.

Member Function Documentation

§ 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 files:

third-party-libs/eigen3/Eigen/src/Core/util/ForwardDeclarations.h
third-party-libs/eigen3/unsupported/Eigen/src/MatrixFunctions/MatrixSquareRoot.h

Public Member Functions

Protected Types

Protected Attributes