Inheritance diagram for TridiagQR< Scalar >:

Public Member Functions
	TridiagQR ()

	TridiagQR (const Matrix &mat)

void	compute (const Matrix &mat)

Matrix	matrix_RQ ()

Public Member Functions inherited from UpperHessenbergQR< Scalar >
	UpperHessenbergQR ()

	UpperHessenbergQR (const Matrix &mat)

Matrix	matrix_R ()

void	apply_QY (Vector &Y)

void	apply_QtY (Vector &Y)

void	apply_QY (Matrix &Y)

void	apply_QtY (Matrix &Y)

void	apply_YQ (Matrix &Y)

void	apply_YQt (Matrix &Y)

Detailed Description

Perform the QR decomposition of a tridiagonal matrix, a special case of upper Hessenberg matrices.

Template Parameters

Scalar The element type of the matrix. Currently supported types are float and double.

Definition at line 396 of file UpperHessenbergQR.h.

Constructor & Destructor Documentation

template<typename Scalar = double>

TridiagQR< Scalar >::TridiagQR ( )

inline

Default constructor. Computation can be performed later by calling the compute() method.

Definition at line 407 of file UpperHessenbergQR.h.

template<typename Scalar = double>

TridiagQR< Scalar >::TridiagQR ( const Matrix & mat )

inline

Constructor to create an object that performs and stores the QR decomposition of a tridiagonal matrix mat.

Parameters

mat	Matrix type can be `arma::mat` or `arma::fmat`, depending on the template parameter `Scalar` defined. Only the major- and sub- diagonal parts of the matrix are used.

Definition at line 420 of file UpperHessenbergQR.h.

template<typename Scalar = double>

void TridiagQR< Scalar >::compute ( const Matrix & mat )

inlinevirtual

Conduct the QR factorization of a tridiagonal matrix.

Parameters

mat	Matrix type can be `arma::mat` or `arma::fmat`, depending on the template parameter `Scalar` defined. Only the major- and sub- diagonal parts of the matrix are used.

Definition at line 434 of file UpperHessenbergQR.h.

template<typename Scalar = double>

Matrix TridiagQR< Scalar >::matrix_RQ ( )

inlinevirtual

Return the \(RQ\) matrix, the multiplication of \(R\) and \(Q\), which is a tridiagonal matrix.

Returns: Returned matrix type will be arma::mat or arma::fmat, depending on the template parameter Scalar defined.

Definition at line 532 of file UpperHessenbergQR.h.

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