Eigen::MatrixFunction< MatrixType, AtomicType, 0 > Class Template Reference

#include <MatrixFunction.h>

Public Member Functions
template<typename ResultType >
void	compute (ResultType &result)
	Compute the matrix function. More...
	MatrixFunction (const MatrixType &A, AtomicType &atomic)
	Constructor. More...

Private Types
typedef Matrix< ComplexScalar, Rows, Cols, Options, MaxRows, MaxCols >	ComplexMatrix
typedef std::complex< Scalar >	ComplexScalar
typedef Traits::Scalar	Scalar
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. More...
AtomicType &	m_atomic
	Class for computing matrix function of atomic blocks. More...

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, typename AtomicType>
class Eigen::MatrixFunction< MatrixType, AtomicType, 0 >

Definition at line 68 of file MatrixFunction.h.

Member Typedef Documentation

template<typename MatrixType , typename AtomicType >

typedef Matrix<ComplexScalar, Rows, Cols, Options, MaxRows, MaxCols> Eigen::MatrixFunction< MatrixType, AtomicType, 0 >::ComplexMatrix

private

Definition at line 81 of file MatrixFunction.h.

template<typename MatrixType , typename AtomicType >

typedef std::complex<Scalar> Eigen::MatrixFunction< MatrixType, AtomicType, 0 >::ComplexScalar

private

Definition at line 80 of file MatrixFunction.h.

template<typename MatrixType , typename AtomicType >

typedef Traits::Scalar Eigen::MatrixFunction< MatrixType, AtomicType, 0 >::Scalar

private

Definition at line 73 of file MatrixFunction.h.

template<typename MatrixType , typename AtomicType >

typedef internal::traits<MatrixType> Eigen::MatrixFunction< MatrixType, AtomicType, 0 >::Traits

private

Definition at line 72 of file MatrixFunction.h.

Constructor & Destructor Documentation

template<typename MatrixType , typename AtomicType >

Eigen::MatrixFunction< MatrixType, AtomicType, 0 >::MatrixFunction ( const MatrixType &  A, AtomicType &  atomic  )

inline

Constructor.

Parameters

[in]	A	argument of matrix function, should be a square matrix.
[in]	atomic	class for computing matrix function of atomic blocks.

Definition at line 90 of file MatrixFunction.h.

Member Function Documentation

template<typename MatrixType , typename AtomicType >

template<typename ResultType >

void Eigen::MatrixFunction< MatrixType, AtomicType, 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 102 of file MatrixFunction.h.

template<typename MatrixType , typename AtomicType >

MatrixFunction& Eigen::MatrixFunction< MatrixType, AtomicType, 0 >::operator= ( const MatrixFunction< MatrixType, AtomicType, 0 > &  )

private

Member Data Documentation

template<typename MatrixType , typename AtomicType >

const int Eigen::MatrixFunction< MatrixType, AtomicType, 0 >::Cols = Traits::ColsAtCompileTime

staticprivate

Definition at line 75 of file MatrixFunction.h.

template<typename MatrixType , typename AtomicType >

internal::nested<MatrixType>::type Eigen::MatrixFunction< MatrixType, AtomicType, 0 >::m_A

private

Reference to argument of matrix function.

Definition at line 112 of file MatrixFunction.h.

template<typename MatrixType , typename AtomicType >

AtomicType& Eigen::MatrixFunction< MatrixType, AtomicType, 0 >::m_atomic

private

Class for computing matrix function of atomic blocks.

Definition at line 113 of file MatrixFunction.h.

template<typename MatrixType , typename AtomicType >

const int Eigen::MatrixFunction< MatrixType, AtomicType, 0 >::MaxCols = Traits::MaxColsAtCompileTime

staticprivate

Definition at line 78 of file MatrixFunction.h.

template<typename MatrixType , typename AtomicType >

const int Eigen::MatrixFunction< MatrixType, AtomicType, 0 >::MaxRows = Traits::MaxRowsAtCompileTime

staticprivate

Definition at line 77 of file MatrixFunction.h.

template<typename MatrixType , typename AtomicType >

const int Eigen::MatrixFunction< MatrixType, AtomicType, 0 >::Options = MatrixType::Options

staticprivate

Definition at line 76 of file MatrixFunction.h.

template<typename MatrixType , typename AtomicType >

const int Eigen::MatrixFunction< MatrixType, AtomicType, 0 >::Rows = Traits::RowsAtCompileTime

staticprivate

Definition at line 74 of file MatrixFunction.h.

---

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

• MatrixFunction.h