W3cubDocs

/Eigen3

Eigen::MatrixLogarithmReturnValue

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

Proxy for the matrix logarithm 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::log() and most of the time this is the only way it is used.

Inherits ReturnByValue< MatrixLogarithmReturnValue< Derived > >.

template<typename ResultType >
void evalTo (ResultType &result) const
Compute the matrix logarithm. More...
MatrixLogarithmReturnValue (const Derived &A)
Constructor. More...

MatrixLogarithmReturnValue()

template<typename Derived >
Eigen::MatrixLogarithmReturnValue< Derived >::MatrixLogarithmReturnValue ( const Derived & A )
inlineexplicit

Constructor.

Parameters
[in] A Matrix (expression) forming the argument of the matrix logarithm.

evalTo()

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

Compute the matrix logarithm.

Parameters
[out] result Logarithm of A, where A is as specified in the constructor.

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