Public Types | 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>

Inheritance diagram for Eigen::MatrixExponentialReturnValue< Derived >:
Inheritance graph
[legend]

Public Types

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

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
 
- Public Member Functions inherited from Eigen::ReturnByValue< MatrixExponentialReturnValue< Derived > >
const Unusablecoeff (Index) const
 
const Unusablecoeff (Index, Index) const
 
UnusablecoeffRef (Index)
 
UnusablecoeffRef (Index, Index)
 
EIGEN_DEVICE_FUNC Index cols () const
 
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC 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 284 of file ForwardDeclarations.h.

Member Typedef Documentation

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

Definition at line 389 of file MatrixExponential.h.

Constructor & Destructor Documentation

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 395 of file MatrixExponential.h.

Member Function Documentation

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

Definition at line 409 of file MatrixExponential.h.

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 402 of file MatrixExponential.h.

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

Definition at line 408 of file MatrixExponential.h.

Member Data Documentation

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

Definition at line 412 of file MatrixExponential.h.


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


hebiros
Author(s): Xavier Artache , Matthew Tesch
autogenerated on Thu Sep 3 2020 04:10:09