Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
 Eigen-unsupported  3.4.99 (git rev 199c5f2b47eb1f8e5a2d20e60f07e97cd95a6ba6)
Eigen::MatrixLogarithmReturnValue< Derived > Class Template Reference

Detailed Description

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 > >.

Public Member Functions

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: