MatrixFunction< MatrixType, 0 > Class Template Reference

Partial specialization of MatrixFunction for real matrices. 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 Matrix< ComplexScalar, Rows, Cols, Options, MaxRows, MaxCols >	ComplexMatrix
typedef std::complex< Scalar >	ComplexScalar
typedef Traits::Scalar	Scalar
typedef internal::stem_function < Scalar >::type	StemFunction
typedef internal::traits < MatrixType >	Traits
Private Member Functions
MatrixFunction &	operator= (const MatrixFunction &)
Private Attributes
internal::nested< MatrixType > ::type	m_A
	Reference to argument of matrix function.
StemFunction *	m_f
	Stem function for matrix function under consideration.
Static Private Attributes
static const int	Cols = Traits::ColsAtCompileTime
static const int	MaxCols = Traits::MaxColsAtCompileTime
static const int	MaxRows = Traits::MaxRowsAtCompileTime
static const int	Options = MatrixType::Options
static const int	Rows = Traits::RowsAtCompileTime

---

Detailed Description

template<typename MatrixType>
class MatrixFunction< MatrixType, 0 >

Partial specialization of MatrixFunction for real matrices.

Definition at line 75 of file MatrixFunction.h.

---

Member Typedef Documentation

template<typename MatrixType >

typedef Matrix<ComplexScalar, Rows, Cols, Options, MaxRows, MaxCols> MatrixFunction< MatrixType, 0 >::ComplexMatrix [private]

Definition at line 88 of file MatrixFunction.h.

template<typename MatrixType >

typedef std::complex<Scalar> MatrixFunction< MatrixType, 0 >::ComplexScalar [private]

Definition at line 87 of file MatrixFunction.h.

template<typename MatrixType >

typedef Traits::Scalar MatrixFunction< MatrixType, 0 >::Scalar [private]

Definition at line 80 of file MatrixFunction.h.

template<typename MatrixType >

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

Definition at line 89 of file MatrixFunction.h.

template<typename MatrixType >

typedef internal::traits<MatrixType> MatrixFunction< MatrixType, 0 >::Traits [private]

Definition at line 79 of file MatrixFunction.h.

---

Constructor & Destructor Documentation

template<typename MatrixType >

MatrixFunction< MatrixType, 0 >::MatrixFunction	(	const MatrixType &	A,
		StemFunction	f
	)		[inline]

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.

Definition at line 98 of file MatrixFunction.h.

---

Member Function Documentation

template<typename MatrixType >

template<typename ResultType >

void MatrixFunction< MatrixType, 0 >::compute

(

ResultType &

result

)

[inline]

Compute the matrix function.

Parameters:

[out]

result

the function f applied to A, as specified in the constructor.

This function converts the real matrix A to a complex matrix, uses MatrixFunction<MatrixType,1> and then converts the result back to a real matrix.

Definition at line 110 of file MatrixFunction.h.

template<typename MatrixType >

MatrixFunction& MatrixFunction< MatrixType, 0 >::operator=

(

const MatrixFunction< MatrixType, 0 > &

)

[private]

---

Member Data Documentation

template<typename MatrixType >

const int MatrixFunction< MatrixType, 0 >::Cols = Traits::ColsAtCompileTime [static, private]

Definition at line 82 of file MatrixFunction.h.

template<typename MatrixType >

internal::nested<MatrixType>::type MatrixFunction< MatrixType, 0 >::m_A [private]

Reference to argument of matrix function.

Definition at line 120 of file MatrixFunction.h.

template<typename MatrixType >

StemFunction* MatrixFunction< MatrixType, 0 >::m_f [private]

Stem function for matrix function under consideration.

Definition at line 121 of file MatrixFunction.h.

template<typename MatrixType >

const int MatrixFunction< MatrixType, 0 >::MaxCols = Traits::MaxColsAtCompileTime [static, private]

Definition at line 85 of file MatrixFunction.h.

template<typename MatrixType >

const int MatrixFunction< MatrixType, 0 >::MaxRows = Traits::MaxRowsAtCompileTime [static, private]

Definition at line 84 of file MatrixFunction.h.

template<typename MatrixType >

const int MatrixFunction< MatrixType, 0 >::Options = MatrixType::Options [static, private]

Definition at line 83 of file MatrixFunction.h.

template<typename MatrixType >

const int MatrixFunction< MatrixType, 0 >::Rows = Traits::RowsAtCompileTime [static, private]

Definition at line 81 of file MatrixFunction.h.

---

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

• MatrixFunction.h