Linear
Linear::Hessenberg< T, N, Flags > Struct Template Reference

Struct for Hessenberg decomposition. More...

#include <Decomp.h>

Public Member Functions

template<size_t M2, size_t N2, unsigned int Flags2>
 Hessenberg (const Matrix< T, M2, N2, Flags2 > &A)
 Constructor. More...
 
template<size_t M2, size_t N2, unsigned int Flags2>
void Compute (const Matrix< T, M2, N2, Flags2 > &A)
 Computes the Hessenberg decomposition. More...
 

Public Attributes

SquareMatrix< T, N, Flags > Q
 
SquareMatrix< T, N, Flags > H
 
SquareMatrix< T, N, Flags > Qh
 

Detailed Description

template<typename T, size_t N, unsigned int Flags = 0>
struct Linear::Hessenberg< T, N, Flags >

Struct for Hessenberg decomposition.

This struct NxN matrix Q and NxN matrix H such that \(A=QHQ^*\) where Q is unitary and H is upper Hessenberg.

Parameters
TType to store matrix entries as.
NNumber of rows/columns for Q and H (both square). Dynamic is allowed for N.
FlagsFlags to pass to the matrices (default = row major).

Constructor & Destructor Documentation

◆ Hessenberg()

template<typename T , size_t N, unsigned int Flags = 0>
template<size_t M2, size_t N2, unsigned int Flags2>
Linear::Hessenberg< T, N, Flags >::Hessenberg ( const Matrix< T, M2, N2, Flags2 > &  A)
inline

Constructor.

Just calls Compute.

Parameters
AM2xN2 Matrix

Member Function Documentation

◆ Compute()

template<typename T , size_t N, unsigned int Flags = 0>
template<size_t M2, size_t N2, unsigned int Flags2>
void Linear::Hessenberg< T, N, Flags >::Compute ( const Matrix< T, M2, N2, Flags2 > &  A)
inline

Computes the Hessenberg decomposition.

If A is not square or Q != N, then an exception is thrown.

Parameters
AM2xN2 Matrix

Member Data Documentation

◆ H

template<typename T , size_t N, unsigned int Flags = 0>
SquareMatrix<T,N,Flags> Linear::Hessenberg< T, N, Flags >::H

Upper Hessenberg matrix

◆ Q

template<typename T , size_t N, unsigned int Flags = 0>
SquareMatrix<T,N,Flags> Linear::Hessenberg< T, N, Flags >::Q

Unitary matrix

◆ Qh

template<typename T , size_t N, unsigned int Flags = 0>
SquareMatrix<T,N,Flags> Linear::Hessenberg< T, N, Flags >::Qh

Qh=ConjugateTranspose(Q)


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