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

#include <ForwardDeclarations.h>

Inheritance diagram for Eigen::MatrixFunctionReturnValue< Derived >:

Public Types
typedef Derived::Index	Index

typedef Derived::Scalar	Scalar

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

Public Types inherited from Eigen::ReturnByValue< MatrixFunctionReturnValue< Derived > >
typedef internal::dense_xpr_base< ReturnByValue >::type	Base

typedef internal::traits< MatrixFunctionReturnValue< Derived > >::ReturnType	ReturnType

Public Member Functions
Index	cols () const

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

	MatrixFunctionReturnValue (const Derived &A, StemFunction f)
	Constructor. More...

Index	rows () const

Public Member Functions inherited from Eigen::ReturnByValue< MatrixFunctionReturnValue< 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

Private Attributes
const DerivedNested	m_A

StemFunction *	m_f

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 285 of file ForwardDeclarations.h.

Member Typedef Documentation

template<typename Derived>

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

protected

Definition at line 487 of file MatrixFunction.h.

template<typename Derived>

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

Definition at line 483 of file MatrixFunction.h.

template<typename Derived>

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

Definition at line 482 of file MatrixFunction.h.

template<typename Derived>

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

Definition at line 484 of file MatrixFunction.h.

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 496 of file MatrixFunction.h.

Member Function Documentation

template<typename Derived>

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

inline

Definition at line 520 of file MatrixFunction.h.

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 503 of file MatrixFunction.h.

template<typename Derived>

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

inline

Definition at line 519 of file MatrixFunction.h.

Member Data Documentation

template<typename Derived>

const DerivedNested Eigen::MatrixFunctionReturnValue< Derived >::m_A

private

Definition at line 523 of file MatrixFunction.h.

template<typename Derived>

StemFunction* Eigen::MatrixFunctionReturnValue< Derived >::m_f

private

Definition at line 524 of file MatrixFunction.h.

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

Public Types

Public Member Functions

Protected Types

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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