gstlrn::EigenVectors Class Reference

Prepare calculations for Eigen or a Generalized Eigen (if 'b' is provided) More...

#include <EigenVectors.hpp>

Detailed Description

Prepare calculations for Eigen or a Generalized Eigen (if 'b' is provided)

Parameters

mat	Square matrix used for Eigen decomposition
b	Auxiliary Square Symmetric matrix used for Generalized Eigen decomposition
optionPositive	Positive flag

Note

: Eigen decomposition is valid for any Square Matrix.

: However, currently, it has only been implemented for Symmetric ones.

: Test isReady() to check if the decomposition has been correctly performed.

Public Member Functions
	EigenVectors (const MatrixSquare &mat, const MatrixSymmetric *b=nullptr, bool optionPositive=true)
	EigenVectors (const EigenVectors &r)=delete
EigenVectors &	operator= (const EigenVectors &r)=delete
virtual	~EigenVectors ()
const &	getEigenValues () const
const MatrixSquare &	getEigenVectors () const
bool	isReady () const

Constructor & Destructor Documentation

EigenVectors() [1/2]

gstlrn::EigenVectors::EigenVectors	(	const MatrixSquare &	mat,
		const MatrixSymmetric *	b = nullptr,
		bool	optionPositive = true
	)

EigenVectors() [2/2]

gstlrn::EigenVectors::EigenVectors ( const EigenVectors &  r )

delete

~EigenVectors()

gstlrn::EigenVectors::~EigenVectors ( )

virtual

Member Function Documentation

getEigenValues()

const & gstlrn::EigenVectors::getEigenValues ( ) const

inline

getEigenVectors()

const MatrixSquare & gstlrn::EigenVectors::getEigenVectors ( ) const

inline

isReady()

bool gstlrn::EigenVectors::isReady ( ) const

inline

operator=()

EigenVectors & gstlrn::EigenVectors::operator= ( const EigenVectors &  r )

delete

---

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

• include/Matrix/EigenVectors.hpp
• src/Matrix/EigenVectors.cpp