Eigen::MatrixFunctionReturnValue< Derived > Class Template Reference

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

#include <ForwardDeclarations.h>

Inheritance diagram for Eigen::MatrixFunctionReturnValue< Derived >:

Public Types
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 EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

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

Member Typedef Documentation

DerivedNested

template<typename Derived >

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

protected

Definition at line 478 of file MatrixFunction.h.

Scalar

template<typename Derived >

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

Definition at line 474 of file MatrixFunction.h.

StemFunction

template<typename Derived >

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

Definition at line 475 of file MatrixFunction.h.

Constructor & Destructor Documentation

MatrixFunctionReturnValue()

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

Member Function Documentation

cols()

template<typename Derived >

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

inline

Definition at line 509 of file MatrixFunction.h.

evalTo()

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

rows()

template<typename Derived >

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

inline

Definition at line 508 of file MatrixFunction.h.

Member Data Documentation

m_A

template<typename Derived >

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

private

Definition at line 512 of file MatrixFunction.h.

m_f

template<typename Derived >

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

private

Definition at line 513 of file MatrixFunction.h.

---

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

• ForwardDeclarations.h
• MatrixFunction.h