Public Member Functions | Protected Attributes | List of all members
Eigen::MatrixExponentialReturnValue< Derived > Struct Template Reference

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

#include <ForwardDeclarations.h>

Public Member Functions

Index cols () const
 
template<typename ResultType >
void evalTo (ResultType &result) const
 Compute the matrix exponential. More...
 
 MatrixExponentialReturnValue (const Derived &src)
 Constructor. More...
 
Index rows () const
 

Protected Attributes

const internal::ref_selector< Derived >::type m_src
 

Detailed Description

template<typename Derived>
struct Eigen::MatrixExponentialReturnValue< Derived >

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

Template Parameters
DerivedType of the argument to the matrix exponential.

This class holds the argument to the matrix exponential 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::exp() and most of the time this is the only way it is used.

Definition at line 304 of file ForwardDeclarations.h.

Constructor & Destructor Documentation

◆ MatrixExponentialReturnValue()

template<typename Derived >
Eigen::MatrixExponentialReturnValue< Derived >::MatrixExponentialReturnValue ( const Derived &  src)
inline

Constructor.

Parameters
srcMatrix (expression) forming the argument of the matrix exponential.

Definition at line 404 of file MatrixExponential.h.

Member Function Documentation

◆ cols()

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

Definition at line 418 of file MatrixExponential.h.

◆ evalTo()

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

Compute the matrix exponential.

Parameters
resultthe matrix exponential of src in the constructor.

Definition at line 411 of file MatrixExponential.h.

◆ rows()

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

Definition at line 417 of file MatrixExponential.h.

Member Data Documentation

◆ m_src

template<typename Derived >
const internal::ref_selector<Derived>::type Eigen::MatrixExponentialReturnValue< Derived >::m_src
protected

Definition at line 421 of file MatrixExponential.h.


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


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:45:21