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

Constructor & Destructor Documentation

MatrixLogarithmReturnValue ( const Derived &  A )

inline

Constructor.

Parameters

[in]

A

Matrix (expression) forming the argument of the matrix logarithm.

Member Function Documentation

void evalTo ( ResultType &  result ) const

inline

Compute the matrix logarithm.

Parameters

[out]

result

Logarithm of A, where is as specified in the constructor.

References MatrixFunction< MatrixType, AtomicType, IsComplex >::compute().

---

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

• MatrixLogarithm.h