compbio
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 <MatrixExponential.h>

Inheritance diagram for Eigen::MatrixExponentialReturnValue< Derived >:
Eigen::ReturnByValue< MatrixExponentialReturnValue< Derived > > Eigen::internal::no_assignment_operator

Public Types

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

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 Index rows () const
 
EIGEN_DEVICE_FUNC Index cols () const
 
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
 

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.

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.

Member Function Documentation

§ 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.

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