W3cubDocs

/Eigen3

Eigen::MatrixFunctionReturnValue

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.

Inherits ReturnByValue< MatrixFunctionReturnValue< Derived > >.

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

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.

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.
The documentation for this class was generated from the following file:

© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/unsupported/classEigen_1_1MatrixFunctionReturnValue.html