WPILibC++ 2023.4.3
Public Types | Public Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Eigen::ComplexEigenSolver< _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/ComplexEigenSolver.h>

Public Types

enum  {
  RowsAtCompileTime = MatrixType::RowsAtCompileTime , ColsAtCompileTime = MatrixType::ColsAtCompileTime , Options = MatrixType::Options , MaxRowsAtCompileTime = MatrixType::MaxRowsAtCompileTime ,
  MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime
}
 
typedef _MatrixType MatrixType
 Synonym for the template parameter _MatrixType. More...
 
typedef MatrixType::Scalar Scalar
 Scalar type for matrices of type MatrixType. More...
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef Eigen::Index Index
 
typedef std::complex< RealScalar > ComplexScalar
 Complex scalar type for MatrixType. More...
 
typedef Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &(~RowMajor), MaxColsAtCompileTime, 1 > EigenvalueType
 Type for vector of eigenvalues as returned by eigenvalues(). More...
 
typedef Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, MaxColsAtCompileTime > EigenvectorType
 Type for matrix of eigenvectors as returned by eigenvectors(). More...
 

Public Member Functions

 ComplexEigenSolver ()
 Default constructor. More...
 
 ComplexEigenSolver (Index size)
 Default Constructor with memory preallocation. More...
 
template<typename InputType >
 ComplexEigenSolver (const EigenBase< InputType > &matrix, bool computeEigenvectors=true)
 Constructor; computes eigendecomposition of given matrix. More...
 
const EigenvectorType & eigenvectors () const
 Returns the eigenvectors of given matrix. More...
 
const EigenvalueType & eigenvalues () const
 Returns the eigenvalues of given matrix. More...
 
template<typename InputType >
ComplexEigenSolver & compute (const EigenBase< InputType > &matrix, bool computeEigenvectors=true)
 Computes eigendecomposition of given matrix. More...
 
ComputationInfo info () const
 Reports whether previous computation was successful. More...
 
ComplexEigenSolver & setMaxIterations (Index maxIters)
 Sets the maximum number of iterations allowed. More...
 
Index getMaxIterations ()
 Returns the maximum number of iterations. More...
 
template<typename InputType >
ComplexEigenSolver< MatrixType > & compute (const EigenBase< InputType > &matrix, bool computeEigenvectors)
 

Static Protected Member Functions

static void check_template_parameters ()
 

Protected Attributes

EigenvectorType m_eivec
 
EigenvalueType m_eivalues
 
ComplexSchur< MatrixType > m_schur
 
bool m_isInitialized
 
bool m_eigenvectorsOk
 
EigenvectorType m_matX
 

Detailed Description

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

\eigenvalues_module

Computes eigenvalues and eigenvectors of general complex matrices

Template Parameters
_MatrixTypethe type of the matrix of which we are computing the eigendecomposition; this is expected to be an instantiation of the Matrix class template.

The eigenvalues and eigenvectors of a matrix \( A \) are scalars \( \lambda \) and vectors \( v \) such that \( Av = \lambda v \). If \( D \) is a diagonal matrix with the eigenvalues on the diagonal, and \( V \) is a matrix with the eigenvectors as its columns, then \( A V = V D \). The matrix \( V \) is almost always invertible, in which case we have \( A = V D V^{-1} \). This is called the eigendecomposition.

The main function in this class is compute(), which computes the eigenvalues and eigenvectors of a given function. The documentation for that function contains an example showing the main features of the class.

See also
class EigenSolver, class SelfAdjointEigenSolver

Member Typedef Documentation

◆ ComplexScalar

template<typename _MatrixType >
typedef std::complex<RealScalar> Eigen::ComplexEigenSolver< _MatrixType >::ComplexScalar

Complex scalar type for MatrixType.

This is std::complex<Scalar> if Scalar is real (e.g., float or double) and just Scalar if Scalar is complex.

◆ EigenvalueType

template<typename _MatrixType >
typedef Matrix<ComplexScalar, ColsAtCompileTime, 1, Options&(~RowMajor), MaxColsAtCompileTime, 1> Eigen::ComplexEigenSolver< _MatrixType >::EigenvalueType

Type for vector of eigenvalues as returned by eigenvalues().

This is a column vector with entries of type ComplexScalar. The length of the vector is the size of MatrixType.

◆ EigenvectorType

template<typename _MatrixType >
typedef Matrix<ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, MaxColsAtCompileTime> Eigen::ComplexEigenSolver< _MatrixType >::EigenvectorType

Type for matrix of eigenvectors as returned by eigenvectors().

This is a square matrix with entries of type ComplexScalar. The size is the same as the size of MatrixType.

◆ Index

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

◆ MatrixType

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

Synonym for the template parameter _MatrixType.

◆ RealScalar

template<typename _MatrixType >
typedef NumTraits<Scalar>::Real Eigen::ComplexEigenSolver< _MatrixType >::RealScalar

◆ Scalar

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

Scalar type for matrices of type MatrixType.

Member Enumeration Documentation

◆ anonymous enum

template<typename _MatrixType >
anonymous enum
Enumerator
RowsAtCompileTime 
ColsAtCompileTime 
Options 
MaxRowsAtCompileTime 
MaxColsAtCompileTime 

Constructor & Destructor Documentation

◆ ComplexEigenSolver() [1/3]

template<typename _MatrixType >
Eigen::ComplexEigenSolver< _MatrixType >::ComplexEigenSolver ( )
inline

Default constructor.

The default constructor is useful in cases in which the user intends to perform decompositions via compute().

◆ ComplexEigenSolver() [2/3]

template<typename _MatrixType >
Eigen::ComplexEigenSolver< _MatrixType >::ComplexEigenSolver ( Index  size)
inlineexplicit

Default Constructor with memory preallocation.

Like the default constructor but with preallocation of the internal data according to the specified problem size.

See also
ComplexEigenSolver()

◆ ComplexEigenSolver() [3/3]

template<typename _MatrixType >
template<typename InputType >
Eigen::ComplexEigenSolver< _MatrixType >::ComplexEigenSolver ( const EigenBase< InputType > &  matrix,
bool  computeEigenvectors = true 
)
inlineexplicit

Constructor; computes eigendecomposition of given matrix.

Parameters
[in]matrixSquare matrix whose eigendecomposition is to be computed.
[in]computeEigenvectorsIf true, both the eigenvectors and the eigenvalues are computed; if false, only the eigenvalues are computed.

This constructor calls compute() to compute the eigendecomposition.

Member Function Documentation

◆ check_template_parameters()

template<typename _MatrixType >
static void Eigen::ComplexEigenSolver< _MatrixType >::check_template_parameters ( )
inlinestaticprotected

◆ compute() [1/2]

template<typename _MatrixType >
template<typename InputType >
ComplexEigenSolver< MatrixType > & Eigen::ComplexEigenSolver< _MatrixType >::compute ( const EigenBase< InputType > &  matrix,
bool  computeEigenvectors 
)

◆ compute() [2/2]

template<typename _MatrixType >
template<typename InputType >
ComplexEigenSolver & Eigen::ComplexEigenSolver< _MatrixType >::compute ( const EigenBase< InputType > &  matrix,
bool  computeEigenvectors = true 
)

Computes eigendecomposition of given matrix.

Parameters
[in]matrixSquare matrix whose eigendecomposition is to be computed.
[in]computeEigenvectorsIf true, both the eigenvectors and the eigenvalues are computed; if false, only the eigenvalues are computed.
Returns
Reference to *this

This function computes the eigenvalues of the complex matrix matrix. The eigenvalues() function can be used to retrieve them. If computeEigenvectors is true, then the eigenvectors are also computed and can be retrieved by calling eigenvectors().

The matrix is first reduced to Schur form using the ComplexSchur class. The Schur decomposition is then used to compute the eigenvalues and eigenvectors.

The cost of the computation is dominated by the cost of the Schur decomposition, which is \( O(n^3) \) where \( n \) is the size of the matrix.

Example:

Output: 

 






◆ eigenvalues()








template<typename _MatrixType > 



  

  
      

        

          const EigenvalueType & Eigen::ComplexEigenSolver< _MatrixType >::eigenvalues 
          (
          )
           const
        

      

  		
  
inline  
  







Returns the eigenvalues of given matrix. 


Returns
A const reference to the column vector containing the eigenvalues.


Precondition
Either the constructor ComplexEigenSolver(const MatrixType& matrix, bool) or the member function compute(const MatrixType& matrix, bool) has been called before to compute the eigendecomposition of a matrix.


This function returns a column vector containing the eigenvalues. Eigenvalues are repeated according to their algebraic multiplicity, so there are as many eigenvalues as rows in the matrix. The eigenvalues are not sorted in any particular order.


Example: 
 Output: 
 






◆ eigenvectors()








template<typename _MatrixType > 



  

  
      

        

          const EigenvectorType & Eigen::ComplexEigenSolver< _MatrixType >::eigenvectors 
          (
          )
           const
        

      

  		
  
inline  
  







Returns the eigenvectors of given matrix. 


Returns
A const reference to the matrix whose columns are the eigenvectors.


Precondition
Either the constructor ComplexEigenSolver(const MatrixType& matrix, bool) or the member function compute(const MatrixType& matrix, bool) has been called before to compute the eigendecomposition of a matrix, and computeEigenvectors was set to true (the default).


This function returns a matrix whose columns are the eigenvectors. Column \( k \) is an eigenvector corresponding to eigenvalue number \( k
\) as returned by eigenvalues(). The eigenvectors are normalized to have (Euclidean) norm equal to one. The matrix returned by this function is the matrix \( V \) in the eigendecomposition \( A = V D
V^{-1} \), if it exists.


Example: 
 Output: 
 






◆ getMaxIterations()








template<typename _MatrixType > 



  

  
      

        

          Index Eigen::ComplexEigenSolver< _MatrixType >::getMaxIterations 
          (
          )
          
        

      

  		
  
inline  
  







Returns the maximum number of iterations. 








◆ info()








template<typename _MatrixType > 



  

  
      

        

          ComputationInfo Eigen::ComplexEigenSolver< _MatrixType >::info 
          (
          )
           const
        

      

  		
  
inline  
  







Reports whether previous computation was successful. 


Returns
Success if computation was successful, NoConvergence otherwise. 








◆ setMaxIterations()








template<typename _MatrixType > 



  

  
      

        

          ComplexEigenSolver & Eigen::ComplexEigenSolver< _MatrixType >::setMaxIterations 
          (
          Index 
          maxIters)
          
        

      

  		
  
inline  
  







Sets the maximum number of iterations allowed. 







Member Data Documentation



◆ m_eigenvectorsOk








template<typename _MatrixType > 



  

  
      

        

          bool Eigen::ComplexEigenSolver< _MatrixType >::m_eigenvectorsOk
        

      

  		
  
protected  
  












◆ m_eivalues








template<typename _MatrixType > 



  

  
      

        

          EigenvalueType Eigen::ComplexEigenSolver< _MatrixType >::m_eivalues
        

      

  		
  
protected  
  












◆ m_eivec








template<typename _MatrixType > 



  

  
      

        

          EigenvectorType Eigen::ComplexEigenSolver< _MatrixType >::m_eivec
        

      

  		
  
protected  
  












◆ m_isInitialized








template<typename _MatrixType > 



  

  
      

        

          bool Eigen::ComplexEigenSolver< _MatrixType >::m_isInitialized
        

      

  		
  
protected  
  












◆ m_matX








template<typename _MatrixType > 



  

  
      

        

          EigenvectorType Eigen::ComplexEigenSolver< _MatrixType >::m_matX
        

      

  		
  
protected  
  












◆ m_schur








template<typename _MatrixType > 



  

  
      

        

          ComplexSchur<MatrixType> Eigen::ComplexEigenSolver< _MatrixType >::m_schur
        

      

  		
  
protected  
  











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