Eigen::MatrixFunction< MatrixType, IsComplex > Class Template Reference

---

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:

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

List of all members.

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

---

Member Typedef Documentation

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

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

Definition at line 42 of file MatrixFunctions.

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

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

Definition at line 43 of file MatrixFunctions.

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

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

Definition at line 44 of file MatrixFunctions.

---

Constructor & Destructor Documentation

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

Eigen::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 Eigen::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.