Eigen::MatrixFunctionReturnValue< Derived > Class Template Reference

---

Detailed Description

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

Proxy for the matrix function of some matrix (expression).

Template Parameters:

Derived

Type of the argument to the matrix function.

This class holds the argument to the matrix function 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::matrixFunction() and related functions and most of the time this is the only way it is used.

Definition at line 498 of file MatrixFunctions.

Inheritance diagram for Eigen::MatrixFunctionReturnValue< Derived >:

List of all members.

Public Types
typedef Derived::Scalar	Scalar
typedef Derived::Index	Index
typedef internal::stem_function < Scalar >::type	StemFunction
typedef internal::traits < MatrixFunctionReturnValue < Derived > >::ReturnType	ReturnType
typedef internal::dense_xpr_base < ReturnByValue >::type	Base
Public Member Functions
	MatrixFunctionReturnValue (const Derived &A, StemFunction f)
	Constructor.
template<typename ResultType >
void	evalTo (ResultType &result) const
	Compute the matrix function.
Index	rows () const
Index	cols () const
void	evalTo (Dest &dst) const
Private Member Functions
MatrixFunctionReturnValue &	operator= (const MatrixFunctionReturnValue &)
Private Attributes
internal::nested< Derived >::type	m_A
StemFunction *	m_f

---

Member Typedef Documentation

typedef internal::dense_xpr_base<ReturnByValue>::type Eigen::ReturnByValue< MatrixFunctionReturnValue< Derived > >::Base [inherited]

Definition at line 70 of file Core.

template<typename Derived >

typedef Derived::Index Eigen::MatrixFunctionReturnValue< Derived >::Index

Definition at line 504 of file MatrixFunctions.

typedef internal::traits<MatrixFunctionReturnValue< Derived > >::ReturnType Eigen::ReturnByValue< MatrixFunctionReturnValue< Derived > >::ReturnType [inherited]

Definition at line 68 of file Core.

template<typename Derived >

typedef Derived::Scalar Eigen::MatrixFunctionReturnValue< Derived >::Scalar

Definition at line 503 of file MatrixFunctions.

template<typename Derived >

typedef internal::stem_function<Scalar>::type Eigen::MatrixFunctionReturnValue< Derived >::StemFunction

Definition at line 505 of file MatrixFunctions.

---

Constructor & Destructor Documentation

template<typename Derived >

Eigen::MatrixFunctionReturnValue< Derived >::MatrixFunctionReturnValue	(	const Derived &	A,
		StemFunction	f
	)		[inline]

Constructor.

Parameters:

[in]	A	Matrix (expression) forming the argument of the matrix function.
[in]	f	Stem function for matrix function under consideration.

Definition at line 513 of file MatrixFunctions.

---

Member Function Documentation

template<typename Derived >

Index Eigen::MatrixFunctionReturnValue< Derived >::cols

(

void

)

const [inline]

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

Definition at line 529 of file MatrixFunctions.

void Eigen::ReturnByValue< MatrixFunctionReturnValue< Derived > >::evalTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 74 of file Core.

template<typename Derived >

template<typename ResultType >

void Eigen::MatrixFunctionReturnValue< Derived >::evalTo

(

ResultType &

result

)

const [inline]

Compute the matrix function.

Parameters:

[out]

result

f applied to A, where f and A are as in the constructor.

Definition at line 521 of file MatrixFunctions.

template<typename Derived >

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

(

const MatrixFunctionReturnValue< Derived > &

)

[private]

template<typename Derived >

Index Eigen::MatrixFunctionReturnValue< Derived >::rows

(

void

)

const [inline]

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

Definition at line 528 of file MatrixFunctions.

---

Member Data Documentation

template<typename Derived >

internal::nested<Derived>::type Eigen::MatrixFunctionReturnValue< Derived >::m_A [private]

Definition at line 532 of file MatrixFunctions.

template<typename Derived >

StemFunction* Eigen::MatrixFunctionReturnValue< Derived >::m_f [private]

Definition at line 533 of file MatrixFunctions.