$treeview $search $mathjax
$projectbrief
$projectbrief
$searchbox

MatrixExponentialReturnValue< Derived > Struct Template Reference
[Matrix functions module]

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

Inherits ReturnByValue< MatrixExponentialReturnValue< Derived > >.

List of all members.

Public Member Functions

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

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 ( const Derived &  src  )  [inline]

Constructor.

Parameters:
[in] src Matrix (expression) forming the argument of the matrix exponential.

Member Function Documentation

void evalTo ( ResultType &  result  )  const [inline]

Compute the matrix exponential.

Parameters:
[out] result the matrix exponential of src in the constructor.

References MatrixExponential< MatrixType >::compute().


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