Public Member Functions | List of all members
MatrixFunction< MatrixType, IsComplex > Class Template Reference

Class for computing matrix exponentials. More...

Public Member Functions

template<typename ResultType >
void compute (ResultType &result)
 Compute the matrix function. More...
 
 MatrixFunction (const MatrixType &A, StemFunction f)
 Constructor. More...
 

Detailed Description

template<typename MatrixType, int IsComplex = NumTraits<typename internal::traits<MatrixType>::Scalar>::IsComplex>
class Eigen::MatrixFunction< MatrixType, IsComplex >

Class for computing matrix exponentials.

Template Parameters
MatrixTypetype of the argument of the matrix function, expected to be an instantiation of the Matrix class template.

Constructor & Destructor Documentation

MatrixFunction ( const MatrixType &  A,
StemFunction  f 
)

Constructor.

Parameters
[in]Aargument of matrix function, should be a square matrix.
[in]fan entire function; f(x,n) should compute the n-th derivative of f at x.

The class stores a reference to A, so it should not be changed (or destroyed) before compute() is called.

Member Function Documentation

void compute ( ResultType &  result)

Compute the matrix function.

Parameters
[out]resultthe function f applied to A, as specified in the constructor.

See MatrixBase::matrixFunction() for details on how this computation is implemented.


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