Public Types | Public Member Functions | Protected Types | Private Attributes | List of all members
Eigen::MatrixLogarithmReturnValue< Derived > Class Template Reference

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

#include <ForwardDeclarations.h>

Public Types

typedef Derived::Index Index
 
typedef Derived::Scalar Scalar
 

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
 

Protected Types

typedef internal::ref_selector< Derived >::type DerivedNested
 

Private Attributes

const DerivedNested m_A
 

Detailed Description

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

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

Template Parameters
DerivedType 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 307 of file ForwardDeclarations.h.

Member Typedef Documentation

◆ DerivedNested

template<typename Derived >
typedef internal::ref_selector<Derived>::type Eigen::MatrixLogarithmReturnValue< Derived >::DerivedNested
protected

Definition at line 317 of file MatrixLogarithm.h.

◆ Index

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

Definition at line 314 of file MatrixLogarithm.h.

◆ Scalar

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

Definition at line 313 of file MatrixLogarithm.h.

Constructor & Destructor Documentation

◆ MatrixLogarithmReturnValue()

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

Constructor.

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

Definition at line 325 of file MatrixLogarithm.h.

Member Function Documentation

◆ cols()

template<typename Derived >
Index Eigen::MatrixLogarithmReturnValue< Derived >::cols ( ) const
inline

Definition at line 346 of file MatrixLogarithm.h.

◆ evalTo()

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

Compute the matrix logarithm.

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

Definition at line 332 of file MatrixLogarithm.h.

◆ rows()

template<typename Derived >
Index Eigen::MatrixLogarithmReturnValue< Derived >::rows ( ) const
inline

Definition at line 345 of file MatrixLogarithm.h.

Member Data Documentation

◆ m_A

template<typename Derived >
const DerivedNested Eigen::MatrixLogarithmReturnValue< Derived >::m_A
private

Definition at line 349 of file MatrixLogarithm.h.


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


gtsam
Author(s):
autogenerated on Sat Nov 16 2024 04:11:16