WPILibC++ 2023.4.3-108-ge5452e3
Public Types | Public Member Functions | Protected Attributes | List of all members
Eigen::HessenbergDecomposition< _MatrixType > Class Template Reference
Eigenvalues module

\eigenvalues_module More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Eigenvalues/HessenbergDecomposition.h>

Public Types

enum  {
  Size = MatrixType::RowsAtCompileTime , SizeMinusOne = Size == Dynamic ? Dynamic : Size - 1 , Options = MatrixType::Options , MaxSize = MatrixType::MaxRowsAtCompileTime ,
  MaxSizeMinusOne = MaxSize == Dynamic ? Dynamic : MaxSize - 1
}
 
typedef _MatrixType MatrixType
 Synonym for the template parameter _MatrixType. More...
 
typedef MatrixType::Scalar Scalar
 Scalar type for matrices of type MatrixType. More...
 
typedef Eigen::Index Index
 
typedef Matrix< Scalar, SizeMinusOne, 1, Options &~RowMajor, MaxSizeMinusOne, 1 > CoeffVectorType
 Type for vector of Householder coefficients. More...
 
typedef HouseholderSequence< MatrixType, typename internal::remove_all< typename CoeffVectorType::ConjugateReturnType >::type > HouseholderSequenceType
 Return type of matrixQ() More...
 
typedef internal::HessenbergDecompositionMatrixHReturnType< MatrixType > MatrixHReturnType
 

Public Member Functions

 HessenbergDecomposition (Index size=Size==Dynamic ? 2 :Size)
 Default constructor; the decomposition will be computed later. More...
 
template<typename InputType >
 HessenbergDecomposition (const EigenBase< InputType > &matrix)
 Constructor; computes Hessenberg decomposition of given matrix. More...
 
template<typename InputType >
HessenbergDecomposition & compute (const EigenBase< InputType > &matrix)
 Computes Hessenberg decomposition of given matrix. More...
 
const CoeffVectorType & householderCoefficients () const
 Returns the Householder coefficients. More...
 
const MatrixType & packedMatrix () const
 Returns the internal representation of the decomposition. More...
 
HouseholderSequenceType matrixQ () const
 Reconstructs the orthogonal matrix Q in the decomposition. More...
 
MatrixHReturnType matrixH () const
 Constructs the Hessenberg matrix H in the decomposition. More...
 

Protected Attributes

MatrixType m_matrix
 
CoeffVectorType m_hCoeffs
 
VectorType m_temp
 
bool m_isInitialized
 

Detailed Description

template<typename _MatrixType>
class Eigen::HessenbergDecomposition< _MatrixType >

\eigenvalues_module

Reduces a square matrix to Hessenberg form by an orthogonal similarity transformation

Template Parameters
_MatrixTypethe type of the matrix of which we are computing the Hessenberg decomposition

This class performs an Hessenberg decomposition of a matrix \( A \). In the real case, the Hessenberg decomposition consists of an orthogonal matrix \( Q \) and a Hessenberg matrix \( H \) such that \( A = Q H Q^T \). An orthogonal matrix is a matrix whose inverse equals its transpose ( \( Q^{-1} = Q^T \)). A Hessenberg matrix has zeros below the subdiagonal, so it is almost upper triangular. The Hessenberg decomposition of a complex matrix is \( A = Q H Q^* \) with \( Q \) unitary (that is, \( Q^{-1} = Q^* \)).

Call the function compute() to compute the Hessenberg decomposition of a given matrix. Alternatively, you can use the HessenbergDecomposition(const MatrixType&) constructor which computes the Hessenberg decomposition at construction time. Once the decomposition is computed, you can use the matrixH() and matrixQ() functions to construct the matrices H and Q in the decomposition.

The documentation for matrixH() contains an example of the typical use of this class.

See also
class ComplexSchur, class Tridiagonalization, QR Module

Member Typedef Documentation

◆ CoeffVectorType

template<typename _MatrixType >
typedef Matrix<Scalar, SizeMinusOne, 1, Options & ~RowMajor, MaxSizeMinusOne, 1> Eigen::HessenbergDecomposition< _MatrixType >::CoeffVectorType

Type for vector of Householder coefficients.

This is column vector with entries of type Scalar. The length of the vector is one less than the size of MatrixType, if it is a fixed-side type.

◆ HouseholderSequenceType

template<typename _MatrixType >
typedef HouseholderSequence<MatrixType,typename internal::remove_all<typename CoeffVectorType::ConjugateReturnType>::type> Eigen::HessenbergDecomposition< _MatrixType >::HouseholderSequenceType

Return type of matrixQ()

◆ Index

template<typename _MatrixType >
typedef Eigen::Index Eigen::HessenbergDecomposition< _MatrixType >::Index
Deprecated:
since Eigen 3.3

◆ MatrixHReturnType

template<typename _MatrixType >
typedef internal::HessenbergDecompositionMatrixHReturnType<MatrixType> Eigen::HessenbergDecomposition< _MatrixType >::MatrixHReturnType

◆ MatrixType

template<typename _MatrixType >
typedef _MatrixType Eigen::HessenbergDecomposition< _MatrixType >::MatrixType

Synonym for the template parameter _MatrixType.

◆ Scalar

template<typename _MatrixType >
typedef MatrixType::Scalar Eigen::HessenbergDecomposition< _MatrixType >::Scalar

Scalar type for matrices of type MatrixType.

Member Enumeration Documentation

◆ anonymous enum

template<typename _MatrixType >
anonymous enum
Enumerator
Size 
SizeMinusOne 
Options 
MaxSize 
MaxSizeMinusOne 

Constructor & Destructor Documentation

◆ HessenbergDecomposition() [1/2]

template<typename _MatrixType >
Eigen::HessenbergDecomposition< _MatrixType >::HessenbergDecomposition ( Index  size = Size==Dynamic ? 2 : Size)
inlineexplicit

Default constructor; the decomposition will be computed later.

Parameters
[in]sizeThe size of the matrix whose Hessenberg decomposition will be computed.

The default constructor is useful in cases in which the user intends to perform decompositions via compute(). The size parameter is only used as a hint. It is not an error to give a wrong size, but it may impair performance.

See also
compute() for an example.

◆ HessenbergDecomposition() [2/2]

template<typename _MatrixType >
template<typename InputType >
Eigen::HessenbergDecomposition< _MatrixType >::HessenbergDecomposition ( const EigenBase< InputType > &  matrix)
inlineexplicit

Constructor; computes Hessenberg decomposition of given matrix.

Parameters
[in]matrixSquare matrix whose Hessenberg decomposition is to be computed.

This constructor calls compute() to compute the Hessenberg decomposition.

See also
matrixH() for an example.

Member Function Documentation

◆ compute()

template<typename _MatrixType >
template<typename InputType >
HessenbergDecomposition & Eigen::HessenbergDecomposition< _MatrixType >::compute ( const EigenBase< InputType > &  matrix)
inline

Computes Hessenberg decomposition of given matrix.

Parameters
[in]matrixSquare matrix whose Hessenberg decomposition is to be computed.
Returns
Reference to *this

The Hessenberg decomposition is computed by bringing the columns of the matrix successively in the required form using Householder reflections (see, e.g., Algorithm 7.4.2 in Golub & Van Loan, Matrix Computations). The cost is \( 10n^3/3 \) flops, where \( n \) denotes the size of the given matrix.

This method reuses of the allocated data in the HessenbergDecomposition object.

Example:

Output: 

 






◆ householderCoefficients()








template<typename _MatrixType > 



  

  
      

        

          const CoeffVectorType & Eigen::HessenbergDecomposition< _MatrixType >::householderCoefficients 
          (
          )
           const
        

      

  		
  
inline  
  







Returns the Householder coefficients. 


Returns
a const reference to the vector of Householder coefficients


Precondition
Either the constructor HessenbergDecomposition(const MatrixType&) or the member function compute(const MatrixType&) has been called before to compute the Hessenberg decomposition of a matrix.


The Householder coefficients allow the reconstruction of the matrix \( Q \) in the Hessenberg decomposition from the packed data.


See also
packedMatrix(), Householder module 








◆ matrixH()








template<typename _MatrixType > 



  

  
      

        

          MatrixHReturnType Eigen::HessenbergDecomposition< _MatrixType >::matrixH 
          (
          )
           const
        

      

  		
  
inline  
  







Constructs the Hessenberg matrix H in the decomposition. 


Returns
expression object representing the matrix H


Precondition
Either the constructor HessenbergDecomposition(const MatrixType&) or the member function compute(const MatrixType&) has been called before to compute the Hessenberg decomposition of a matrix.


The object returned by this function constructs the Hessenberg matrix H when it is assigned to a matrix or otherwise evaluated. The matrix H is constructed from the packed matrix as returned by packedMatrix(): The upper part (including the subdiagonal) of the packed matrix contains the matrix H. It may sometimes be better to directly use the packed matrix instead of constructing the matrix H.


Example: 
 Output: 
See also
matrixQ(), packedMatrix() 








◆ matrixQ()








template<typename _MatrixType > 



  

  
      

        

          HouseholderSequenceType Eigen::HessenbergDecomposition< _MatrixType >::matrixQ 
          (
          void 
          )
           const
        

      

  		
  
inline  
  







Reconstructs the orthogonal matrix Q in the decomposition. 


Returns
object representing the matrix Q


Precondition
Either the constructor HessenbergDecomposition(const MatrixType&) or the member function compute(const MatrixType&) has been called before to compute the Hessenberg decomposition of a matrix.


This function returns a light-weight object of template class HouseholderSequence. You can either apply it directly to a matrix or you can convert it to a matrix of type MatrixType.


See also
matrixH() for an example, class HouseholderSequence 








◆ packedMatrix()








template<typename _MatrixType > 



  

  
      

        

          const MatrixType & Eigen::HessenbergDecomposition< _MatrixType >::packedMatrix 
          (
          )
           const
        

      

  		
  
inline  
  







Returns the internal representation of the decomposition. 


Returns
a const reference to a matrix with the internal representation of the decomposition.


Precondition
Either the constructor HessenbergDecomposition(const MatrixType&) or the member function compute(const MatrixType&) has been called before to compute the Hessenberg decomposition of a matrix.


The returned matrix contains the following information:
    

  • the upper part and lower sub-diagonal represent the Hessenberg matrix H
    • 

  • the rest of the lower part contains the Householder vectors that, combined with Householder coefficients returned by householderCoefficients(), allows to reconstruct the matrix Q as \( Q = H_{N-1} \ldots H_1 H_0 \). Here, the matrices \( H_i \) are the Householder transformations \( H_i = (I - h_i v_i v_i^T) \) where \( h_i \) is the \( i \)th Householder coefficient and \( v_i \) is the Householder vector defined by \( v_i = [ 0, \ldots, 0, 1, M(i+2,i), \ldots, M(N-1,i) ]^T \) with M the matrix returned by this function.
    • 



See LAPACK for further details on this packed storage.


Example: 
 Output: 
See also
householderCoefficients() 







Member Data Documentation



◆ m_hCoeffs








template<typename _MatrixType > 



  

  
      

        

          CoeffVectorType Eigen::HessenbergDecomposition< _MatrixType >::m_hCoeffs
        

      

  		
  
protected  
  












◆ m_isInitialized








template<typename _MatrixType > 



  

  
      

        

          bool Eigen::HessenbergDecomposition< _MatrixType >::m_isInitialized
        

      

  		
  
protected  
  












◆ m_matrix








template<typename _MatrixType > 



  

  
      

        

          MatrixType Eigen::HessenbergDecomposition< _MatrixType >::m_matrix
        

      

  		
  
protected  
  












◆ m_temp








template<typename _MatrixType > 



  

  
      

        

          VectorType Eigen::HessenbergDecomposition< _MatrixType >::m_temp
        

      

  		
  
protected  
  











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