SelfAdjointEigenSolver< _MatrixType > Class Template Reference

Eigen values/vectors solver for selfadjoint matrix. More...

#include <SelfAdjointEigenSolver.h>

List of all members.

Public Types
enum	{ Size = _MatrixType::RowsAtCompileTime }
typedef std::complex< RealScalar >	Complex
typedef _MatrixType	MatrixType
typedef NumTraits< Scalar >::Real	RealScalar
typedef Matrix< RealScalar, MatrixType::ColsAtCompileTime, 1 >	RealVectorType
typedef Matrix< RealScalar, Dynamic, 1 >	RealVectorTypeX
typedef MatrixType::Scalar	Scalar
typedef Tridiagonalization < MatrixType >	TridiagonalizationType
Public Member Functions
void	compute (const MatrixType &matA, const MatrixType &matB, bool computeEigenvectors=true)
void	compute (const MatrixType &matrix, bool computeEigenvectors=true)
RealVectorType	eigenvalues (void) const
MatrixType	eigenvectors (void) const
MatrixType	operatorInverseSqrt () const
MatrixType	operatorSqrt () const
	SelfAdjointEigenSolver (const MatrixType &matA, const MatrixType &matB, bool computeEigenvectors=true)
	SelfAdjointEigenSolver (const MatrixType &matrix, bool computeEigenvectors=true)
	SelfAdjointEigenSolver (int size)
	SelfAdjointEigenSolver ()
Protected Attributes
bool	m_eigenvectorsOk
RealVectorType	m_eivalues
MatrixType	m_eivec

---

Detailed Description

template<typename _MatrixType>
class SelfAdjointEigenSolver< _MatrixType >

Eigen values/vectors solver for selfadjoint matrix.

Parameters:

MatrixType

the type of the matrix of which we are computing the eigen decomposition

Note:

MatrixType must be an actual Matrix type, it can't be an expression type.

See also:

MatrixBase::eigenvalues(), class EigenSolver

Definition at line 41 of file SelfAdjointEigenSolver.h.

---

Member Typedef Documentation

template<typename _MatrixType>

typedef std::complex<RealScalar> SelfAdjointEigenSolver< _MatrixType >::Complex

Definition at line 49 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

typedef _MatrixType SelfAdjointEigenSolver< _MatrixType >::MatrixType

Definition at line 46 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

typedef NumTraits<Scalar>::Real SelfAdjointEigenSolver< _MatrixType >::RealScalar

Definition at line 48 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

typedef Matrix<RealScalar, MatrixType::ColsAtCompileTime, 1> SelfAdjointEigenSolver< _MatrixType >::RealVectorType

Definition at line 50 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

typedef Matrix<RealScalar, Dynamic, 1> SelfAdjointEigenSolver< _MatrixType >::RealVectorTypeX

Definition at line 51 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

typedef MatrixType::Scalar SelfAdjointEigenSolver< _MatrixType >::Scalar

Definition at line 47 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

typedef Tridiagonalization<MatrixType> SelfAdjointEigenSolver< _MatrixType >::TridiagonalizationType

Definition at line 52 of file SelfAdjointEigenSolver.h.

---

Member Enumeration Documentation

template<typename _MatrixType>

anonymous enum

Enumerator:

Size

Definition at line 45 of file SelfAdjointEigenSolver.h.

---

Constructor & Destructor Documentation

template<typename _MatrixType>

SelfAdjointEigenSolver< _MatrixType >::SelfAdjointEigenSolver

(

)

[inline]

Definition at line 54 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

SelfAdjointEigenSolver< _MatrixType >::SelfAdjointEigenSolver

(

int

size

)

[inline]

Definition at line 61 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

SelfAdjointEigenSolver< _MatrixType >::SelfAdjointEigenSolver	(	const MatrixType &	matrix,
		bool	computeEigenvectors = true
	)			[inline]

Constructors computing the eigenvalues of the selfadjoint matrix matrix, as well as the eigenvectors if computeEigenvectors is true.

See also:

compute(MatrixType,bool), SelfAdjointEigenSolver(MatrixType,MatrixType,bool)

Definition at line 71 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

SelfAdjointEigenSolver< _MatrixType >::SelfAdjointEigenSolver	(	const MatrixType &	matA,
		const MatrixType &	matB,
		bool	computeEigenvectors = true
	)			[inline]

Constructors computing the eigenvalues of the generalized eigen problem with matA the selfadjoint matrix and matB the positive definite matrix . The eigenvectors are computed if computeEigenvectors is true.

See also:

compute(MatrixType,MatrixType,bool), SelfAdjointEigenSolver(MatrixType,bool)

Definition at line 85 of file SelfAdjointEigenSolver.h.

---

Member Function Documentation

template<typename MatrixType >

void SelfAdjointEigenSolver< MatrixType >::compute	(	const MatrixType &	matA,
		const MatrixType &	matB,
		bool	computeEigenvectors = true
	)			[inline]

Computes the eigenvalues of the generalized eigen problem with matA the selfadjoint matrix and matB the positive definite matrix . The eigenvectors are computed if computeEigenvectors is true.

See also:

SelfAdjointEigenSolver(MatrixType,MatrixType,bool), compute(MatrixType,bool)

Definition at line 253 of file SelfAdjointEigenSolver.h.

template<typename MatrixType >

void SelfAdjointEigenSolver< MatrixType >::compute	(	const MatrixType &	matrix,
		bool	computeEigenvectors = true
	)			[inline]

Computes the eigenvalues of the selfadjoint matrix matrix, as well as the eigenvectors if computeEigenvectors is true.

See also:

SelfAdjointEigenSolver(MatrixType,bool), compute(MatrixType,MatrixType,bool)

Definition at line 184 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

RealVectorType SelfAdjointEigenSolver< _MatrixType >::eigenvalues

(

void

)

const [inline]

Returns:

the computed eigen values

Definition at line 106 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

MatrixType SelfAdjointEigenSolver< _MatrixType >::eigenvectors

(

void

)

const [inline]

Returns:

the computed eigen vectors as a matrix of column vectors

Definition at line 97 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

MatrixType SelfAdjointEigenSolver< _MatrixType >::operatorInverseSqrt

(

)

const [inline]

Returns:

the positive inverse square root of the matrix

Note:

the matrix itself must be positive definite in order for this to make sense.

Definition at line 121 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

MatrixType SelfAdjointEigenSolver< _MatrixType >::operatorSqrt

(

)

const [inline]

Returns:

the positive square root of the matrix

Note:

the matrix itself must be positive in order for this to make sense.

Definition at line 112 of file SelfAdjointEigenSolver.h.

---

Member Data Documentation

template<typename _MatrixType>

bool SelfAdjointEigenSolver< _MatrixType >::m_eigenvectorsOk [protected]

Definition at line 131 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

RealVectorType SelfAdjointEigenSolver< _MatrixType >::m_eivalues [protected]

Definition at line 129 of file SelfAdjointEigenSolver.h.

template<typename _MatrixType>

MatrixType SelfAdjointEigenSolver< _MatrixType >::m_eivec [protected]

Definition at line 128 of file SelfAdjointEigenSolver.h.

---

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

• SelfAdjointEigenSolver.h