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

#include <MatrixExponential.h>

Inheritance diagram for Eigen::MatrixExponentialReturnValue< Derived >:

Public Member Functions
	MatrixExponentialReturnValue (const Derived &src)
	Constructor. More...

template<typename ResultType >
void	evalTo (ResultType &result) const
	Compute the matrix exponential. More...

Index	rows () const

Index	cols () const

Public Member Functions inherited from Eigen::ReturnByValue< MatrixExponentialReturnValue< Derived > >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

const Unusable &	coeff (Index) const

const Unusable &	coeff (Index, Index) const

Unusable &	coeffRef (Index)

Unusable &	coeffRef (Index, Index)

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

Additional Inherited Members
Public Types inherited from Eigen::ReturnByValue< MatrixExponentialReturnValue< Derived > >
typedef internal::traits< MatrixExponentialReturnValue< Derived > >::ReturnType	ReturnType

typedef internal::dense_xpr_base< ReturnByValue >::type	Base

Detailed Description

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

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

Template Parameters

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

Constructor & Destructor Documentation

◆ MatrixExponentialReturnValue()

template<typename Derived >

Eigen::MatrixExponentialReturnValue< Derived >::MatrixExponentialReturnValue ( const Derived & src )

inline

Constructor.

Parameters

src	Matrix (expression) forming the argument of the matrix exponential.

410 : m_src(src) {}

Eigen::MatrixExponentialReturnValue::m_src

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

Definition: MatrixExponential.h:426

Member Function Documentation

◆ cols()

template<typename Derived >

Index Eigen::MatrixExponentialReturnValue< Derived >::cols ( ) const

inline

423 { return m_src.cols(); }

References Eigen::MatrixExponentialReturnValue< Derived >::m_src.

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

◆ evalTo()

template<typename Derived >

template<typename ResultType >

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

inline

Compute the matrix exponential.

Parameters

result the matrix exponential of src in the constructor.

                                                {
     const typename internal::nested_eval<Derived, 10>::type tmp(m_src);
     internal::matrix_exp_compute(tmp, result, internal::is_exp_known_type<typename Derived::RealScalar>());
   }