Please, help us to better know about our user community by answering the following short survey:
Eigen-unsupported  3.4.99 (git rev 199c5f2b47eb1f8e5a2d20e60f07e97cd95a6ba6)
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
DerivedType 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.

Inherits ReturnByValue< MatrixFunctionReturnValue< Derived > >.

Public Member Functions

template<typename ResultType >
void evalTo (ResultType &result) const
 Compute the matrix function. More...
 MatrixFunctionReturnValue (const Derived &A, StemFunction f)
 Constructor. More...

Constructor & Destructor Documentation

◆ MatrixFunctionReturnValue()

template<typename Derived >
Eigen::MatrixFunctionReturnValue< Derived >::MatrixFunctionReturnValue ( const Derived &  A,
StemFunction  f 


[in]AMatrix (expression) forming the argument of the matrix function.
[in]fStem function for matrix function under consideration.

Member Function Documentation

◆ evalTo()

template<typename Derived >
template<typename ResultType >
void Eigen::MatrixFunctionReturnValue< Derived >::evalTo ( ResultType &  result) const

Compute the matrix function.

[out]resultf applied to A, where f and A are as in the constructor.

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