MatrixFunctionReturnValue< Derived > Class Template Reference

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

#include <MatrixFunction.h>

Inheritance diagram for MatrixFunctionReturnValue< Derived >:

List of all members.

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

---

Detailed Description

template<typename Derived>
class 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 MatrixFunction.h.

---

Member Typedef Documentation

template<typename Derived>

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

Definition at line 504 of file MatrixFunction.h.

template<typename Derived>

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

Definition at line 503 of file MatrixFunction.h.

template<typename Derived>

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

Definition at line 505 of file MatrixFunction.h.

---

Constructor & Destructor Documentation

template<typename Derived>

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 MatrixFunction.h.

---

Member Function Documentation

template<typename Derived>

Index MatrixFunctionReturnValue< Derived >::cols

(

void

)

const [inline]

Reimplemented from ReturnByValue< MatrixFunctionReturnValue< Derived > >.

Definition at line 529 of file MatrixFunction.h.

template<typename Derived>

template<typename ResultType >

void 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 MatrixFunction.h.

template<typename Derived>

MatrixFunctionReturnValue& MatrixFunctionReturnValue< Derived >::operator=

(

const MatrixFunctionReturnValue< Derived > &

)

[private]

template<typename Derived>

Index MatrixFunctionReturnValue< Derived >::rows

(

void

)

const [inline]

Reimplemented from ReturnByValue< MatrixFunctionReturnValue< Derived > >.

Definition at line 528 of file MatrixFunction.h.

---

Member Data Documentation

template<typename Derived>

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

Definition at line 532 of file MatrixFunction.h.

template<typename Derived>

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

Definition at line 533 of file MatrixFunction.h.

---

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

• MatrixFunction.h