Eigen::MatrixLogarithmReturnValue< Derived > Class Template Reference

Proxy for the matrix logarithm of some matrix (expression). More...

#include <ForwardDeclarations.h>

Inheritance diagram for Eigen::MatrixLogarithmReturnValue< Derived >:

Public Types
typedef Derived::Index	Index
typedef Derived::Scalar	Scalar
Public Types inherited from Eigen::ReturnByValue< MatrixLogarithmReturnValue< Derived > >
typedef internal::dense_xpr_base< ReturnByValue >::type	Base
typedef internal::traits< MatrixLogarithmReturnValue< Derived > >::ReturnType	ReturnType

Public Member Functions
Index	cols () const
template<typename ResultType >
void	evalTo (ResultType &result) const
	Compute the matrix logarithm. More...
	MatrixLogarithmReturnValue (const Derived &A)
	Constructor. More...
Index	rows () const
Public Member Functions inherited from Eigen::ReturnByValue< MatrixLogarithmReturnValue< Derived > >
const Unusable &	coeff (Index) const
const Unusable &	coeff (Index, Index) const
Unusable &	coeffRef (Index)
Unusable &	coeffRef (Index, Index)
Index	cols () const
void	evalTo (Dest &dst) const
Index	rows () const

Private Member Functions
MatrixLogarithmReturnValue &	operator= (const MatrixLogarithmReturnValue &)

Private Attributes
internal::nested< Derived >::type	m_A

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.

Definition at line 272 of file ForwardDeclarations.h.

Member Typedef Documentation

template<typename Derived>

typedef Derived::Index Eigen::MatrixLogarithmReturnValue< Derived >::Index

Definition at line 426 of file MatrixLogarithm.h.

template<typename Derived>

typedef Derived::Scalar Eigen::MatrixLogarithmReturnValue< Derived >::Scalar

Definition at line 425 of file MatrixLogarithm.h.

Constructor & Destructor Documentation

template<typename Derived>

Eigen::MatrixLogarithmReturnValue< Derived >::MatrixLogarithmReturnValue ( const Derived &  A )

inline

Constructor.

Parameters

[in]

A

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

Definition at line 432 of file MatrixLogarithm.h.

Member Function Documentation

template<typename Derived>

Index Eigen::MatrixLogarithmReturnValue< Derived >::cols ( void  ) const

inline

Definition at line 457 of file MatrixLogarithm.h.

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 is as specified in the constructor.

Definition at line 439 of file MatrixLogarithm.h.

template<typename Derived>

MatrixLogarithmReturnValue& Eigen::MatrixLogarithmReturnValue< Derived >::operator= ( const MatrixLogarithmReturnValue< Derived > &  )

private

template<typename Derived>

Index Eigen::MatrixLogarithmReturnValue< Derived >::rows ( void  ) const

inline

Definition at line 456 of file MatrixLogarithm.h.

Member Data Documentation

template<typename Derived>

internal::nested<Derived>::type Eigen::MatrixLogarithmReturnValue< Derived >::m_A

private

Definition at line 460 of file MatrixLogarithm.h.

---

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

• ForwardDeclarations.h
• MatrixLogarithm.h