Eigen::MatrixFunctionReturnValue< Derived > Class Template Reference

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

#include <MatrixFunction.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::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
Public Member Functions inherited from Eigen::ReturnByValue< MatrixFunctionReturnValue< Derived > >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
const Unusable &	coeff (Index) const
const Unusable &	coeff (Index, Index) const
Unusable &	coeffRef (Index)
Unusable &	coeffRef (Index, Index)

Protected Types
typedef internal::ref_selector< Derived >::type	DerivedNested

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.

Member Typedef Documentation

DerivedNested

template<typename Derived >

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

protected

Scalar

template<typename Derived >

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

StemFunction

template<typename Derived >

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

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.

Member Function Documentation

cols()

template<typename Derived >

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

inline

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.

rows()

template<typename Derived >

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

inline

---

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

• core/util/algorithms/eigen-3.4.0/Eigen/src/Core/util/ForwardDeclarations.h
• core/util/algorithms/eigen-3.4.0/unsupported/Eigen/src/MatrixFunctions/MatrixFunction.h