MatrixFunction< MatrixType, IsComplex > Class Template Reference

Class for computing matrix exponentials. More...

#include <MatrixFunction.h>

List of all members.

Public Member Functions
template<typename ResultType >
void	compute (ResultType &result)
	Compute the matrix function.
	MatrixFunction (const MatrixType &A, StemFunction f)
	Constructor.
Private Types
typedef internal::traits < MatrixType >::Index	Index
typedef internal::traits < MatrixType >::Scalar	Scalar
typedef internal::stem_function < Scalar >::type	StemFunction

---

Detailed Description

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

Class for computing matrix exponentials.

Template Parameters:

MatrixType

type of the argument of the matrix function, expected to be an instantiation of the Matrix class template.

Definition at line 38 of file MatrixFunction.h.

---

Member Typedef Documentation

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

typedef internal::traits<MatrixType>::Index MatrixFunction< MatrixType, IsComplex >::Index [private]

Definition at line 42 of file MatrixFunction.h.

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

typedef internal::traits<MatrixType>::Scalar MatrixFunction< MatrixType, IsComplex >::Scalar [private]

Definition at line 43 of file MatrixFunction.h.

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

typedef internal::stem_function<Scalar>::type MatrixFunction< MatrixType, IsComplex >::StemFunction [private]

Definition at line 44 of file MatrixFunction.h.

---

Constructor & Destructor Documentation

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

MatrixFunction< MatrixType, IsComplex >::MatrixFunction	(	const MatrixType &	A,
		StemFunction	f
	)

Constructor.

Parameters:

[in]	A	argument of matrix function, should be a square matrix.
[in]	f	an 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

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

template<typename ResultType >

void MatrixFunction< MatrixType, IsComplex >::compute

(

ResultType &

result

)

Compute the matrix function.

Parameters:

[out]

result

the 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:

• MatrixFunction.h