Eigen::MatrixFunctionAtomic< MatrixType > Class Template Reference

Helper class for computing matrix functions of atomic matrices. More...

#include <MatrixFunctionAtomic.h>

Public Types
typedef MatrixType::Index	Index
typedef NumTraits< Scalar >::Real	RealScalar
typedef MatrixType::Scalar	Scalar
typedef internal::stem_function< Scalar >::type	StemFunction
typedef Matrix< Scalar, MatrixType::RowsAtCompileTime, 1 >	VectorType

Public Member Functions
MatrixType	compute (const MatrixType &A)
	Compute matrix function of atomic matrix. More...
	MatrixFunctionAtomic (StemFunction f)
	Constructor. More...

Private Member Functions
void	computeMu ()
	Compute m_mu. More...
	MatrixFunctionAtomic (const MatrixFunctionAtomic &)
MatrixFunctionAtomic &	operator= (const MatrixFunctionAtomic &)
bool	taylorConverged (Index s, const MatrixType &F, const MatrixType &Fincr, const MatrixType &P)
	Determine whether Taylor series has converged. More...

Private Attributes
Index	m_Arows
	Size of matrix function. More...
MatrixType	m_Ashifted
	Argument shifted by mean of eigenvalues. More...
Scalar	m_avgEival
	Mean of eigenvalues. More...
StemFunction *	m_f
	Pointer to scalar function. More...
RealScalar	m_mu
	Constant used to determine whether Taylor series has converged. More...

Detailed Description

template<typename MatrixType>
class Eigen::MatrixFunctionAtomic< MatrixType >

Helper class for computing matrix functions of atomic matrices.

Definition at line 24 of file MatrixFunctionAtomic.h.

Member Typedef Documentation

Index

template<typename MatrixType >

typedef MatrixType::Index Eigen::MatrixFunctionAtomic< MatrixType >::Index

Definition at line 29 of file MatrixFunctionAtomic.h.

RealScalar

template<typename MatrixType >

typedef NumTraits<Scalar>::Real Eigen::MatrixFunctionAtomic< MatrixType >::RealScalar

Definition at line 30 of file MatrixFunctionAtomic.h.

Scalar

template<typename MatrixType >

typedef MatrixType::Scalar Eigen::MatrixFunctionAtomic< MatrixType >::Scalar

Definition at line 28 of file MatrixFunctionAtomic.h.

StemFunction

template<typename MatrixType >

typedef internal::stem_function<Scalar>::type Eigen::MatrixFunctionAtomic< MatrixType >::StemFunction

Definition at line 31 of file MatrixFunctionAtomic.h.

VectorType

template<typename MatrixType >

typedef Matrix<Scalar, MatrixType::RowsAtCompileTime, 1> Eigen::MatrixFunctionAtomic< MatrixType >::VectorType

Definition at line 32 of file MatrixFunctionAtomic.h.

Constructor & Destructor Documentation

MatrixFunctionAtomic() [1/2]

template<typename MatrixType >

Eigen::MatrixFunctionAtomic< MatrixType >::MatrixFunctionAtomic ( StemFunction  f )

inline

Constructor.

Parameters

[in]

f

matrix function to compute.

Definition at line 37 of file MatrixFunctionAtomic.h.

MatrixFunctionAtomic() [2/2]

template<typename MatrixType >

Eigen::MatrixFunctionAtomic< MatrixType >::MatrixFunctionAtomic ( const MatrixFunctionAtomic< MatrixType > &  )

private

Member Function Documentation

compute()

template<typename MatrixType >

MatrixType Eigen::MatrixFunctionAtomic< MatrixType >::compute

(

const MatrixType &

A

)

Compute matrix function of atomic matrix.

Parameters

[in]

A

argument of matrix function, should be upper triangular and atomic

Returns

f(A), the matrix function evaluated at the given matrix

Definition at line 71 of file MatrixFunctionAtomic.h.

computeMu()

template<typename MatrixType >

void Eigen::MatrixFunctionAtomic< MatrixType >::computeMu ( )

private

Compute m_mu.

Definition at line 95 of file MatrixFunctionAtomic.h.

operator=()

template<typename MatrixType >

MatrixFunctionAtomic& Eigen::MatrixFunctionAtomic< MatrixType >::operator= ( const MatrixFunctionAtomic< MatrixType > &  )

private

taylorConverged()

template<typename MatrixType >

bool Eigen::MatrixFunctionAtomic< MatrixType >::taylorConverged ( Index  s, const MatrixType &  F, const MatrixType &  Fincr, const MatrixType &  P  )

private

Determine whether Taylor series has converged.

Definition at line 105 of file MatrixFunctionAtomic.h.

Member Data Documentation

m_Arows

template<typename MatrixType >

Index Eigen::MatrixFunctionAtomic< MatrixType >::m_Arows

private

Size of matrix function.

Definition at line 58 of file MatrixFunctionAtomic.h.

m_Ashifted

template<typename MatrixType >

MatrixType Eigen::MatrixFunctionAtomic< MatrixType >::m_Ashifted

private

Argument shifted by mean of eigenvalues.

Definition at line 64 of file MatrixFunctionAtomic.h.

m_avgEival

template<typename MatrixType >

Scalar Eigen::MatrixFunctionAtomic< MatrixType >::m_avgEival

private

Mean of eigenvalues.

Definition at line 61 of file MatrixFunctionAtomic.h.

m_f

template<typename MatrixType >

StemFunction* Eigen::MatrixFunctionAtomic< MatrixType >::m_f

private

Pointer to scalar function.

Definition at line 55 of file MatrixFunctionAtomic.h.

m_mu

template<typename MatrixType >

RealScalar Eigen::MatrixFunctionAtomic< MatrixType >::m_mu

private

Constant used to determine whether Taylor series has converged.

Definition at line 67 of file MatrixFunctionAtomic.h.

---

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

• MatrixFunctionAtomic.h