Eigen::MatrixSquareRootReturnValue< Derived > Class Template Reference

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

#include <MatrixSquareRoot.h>

Inheritance diagram for Eigen::MatrixSquareRootReturnValue< Derived >:

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
Private Types
typedef Derived::Index	Index
Private Member Functions
MatrixSquareRootReturnValue &	operator= (const MatrixSquareRootReturnValue &)

---

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 415 of file MatrixSquareRoot.h.

---

Member Typedef Documentation

template<typename Derived>

typedef Derived::Index Eigen::MatrixSquareRootReturnValue< Derived >::Index [private]

Definition at line 418 of file MatrixSquareRoot.h.

---

Constructor & Destructor Documentation

template<typename Derived>

Eigen::MatrixSquareRootReturnValue< Derived >::MatrixSquareRootReturnValue

(

const Derived &

src

)

[inline]

Constructor.

Parameters:

[in]

src

Matrix (expression) forming the argument of the matrix square root.

Definition at line 425 of file MatrixSquareRoot.h.

---

Member Function Documentation

template<typename Derived>

Index Eigen::MatrixSquareRootReturnValue< Derived >::cols

(

void

)

const [inline]

Reimplemented from Eigen::ReturnByValue< MatrixSquareRootReturnValue< Derived > >.

Definition at line 441 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 433 of file MatrixSquareRoot.h.

template<typename Derived>

MatrixSquareRootReturnValue& Eigen::MatrixSquareRootReturnValue< Derived >::operator=

(

const MatrixSquareRootReturnValue< Derived > &

)

[private]

template<typename Derived>

Index Eigen::MatrixSquareRootReturnValue< Derived >::rows

(

void

)

const [inline]

Reimplemented from Eigen::ReturnByValue< MatrixSquareRootReturnValue< Derived > >.

Definition at line 440 of file MatrixSquareRoot.h.

---

Member Data Documentation

template<typename Derived>

const Derived& Eigen::MatrixSquareRootReturnValue< Derived >::m_src [protected]

Definition at line 444 of file MatrixSquareRoot.h.

---

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

• MatrixSquareRoot.h