Spectral Integral Suite in C++
sis::EigenSorter< T > Class Template Reference

This class stores functions and values needed to sort Eigenvalues. More...

#include <sis.hpp>

Public Member Functions

 EigenSorter ()
 Null constructor. More...
 
void compute (Eigen::Matrix< std::complex< T >, Eigen::Dynamic, 1 > in)
 Computes Mp and numMp for Linops. More...
 
void compute (Eigen::Matrix< std::complex< T >, Eigen::Dynamic, 1 > in, int c)
 Computes Mp and numMp for LinopMats. More...
 

Public Attributes

epsilon
 
bool Mp
 Stores true if machine precision is reached, else false. More...
 
int numMp
 Stores number of Chebyshev coefficients in which MP is reached, if not reached, it is set to N+1. More...
 
minVal
 Stores the smallest value in the Chebyshev series. More...
 
bool isInf
 

Detailed Description

template<class T>
class sis::EigenSorter< T >

This class stores functions and values needed to sort Eigenvalues.

Definition at line 3126 of file sis.hpp.

Constructor & Destructor Documentation

◆ EigenSorter()

template<class T >
sis::EigenSorter< T >::EigenSorter ( )
inline

Null constructor.

Definition at line 3140 of file sis.hpp.

References sis::EigenSorter< T >::epsilon, sis::EigenSorter< T >::minVal, and sis::EigenSorter< T >::numMp.

Member Function Documentation

◆ compute() [1/2]

template<class T >
void sis::EigenSorter< T >::compute ( Eigen::Matrix< std::complex< T >, Eigen::Dynamic, 1 >  in)
inline

◆ compute() [2/2]

template<class T >
void sis::EigenSorter< T >::compute ( Eigen::Matrix< std::complex< T >, Eigen::Dynamic, 1 >  in,
int  c 
)
inline

Member Data Documentation

◆ epsilon

template<class T >
T sis::EigenSorter< T >::epsilon

Machine zero, needs to be set based on Matrix computation errors

Definition at line 3129 of file sis.hpp.

Referenced by sis::EigenSorter< T >::compute(), and sis::EigenSorter< T >::EigenSorter().

◆ isInf

template<class T >
bool sis::EigenSorter< T >::isInf

in case Machine precision is not reached. If Machine precision is reached, it is set to zero.

Definition at line 3137 of file sis.hpp.

◆ minVal

template<class T >
T sis::EigenSorter< T >::minVal

Stores the smallest value in the Chebyshev series.

Definition at line 3134 of file sis.hpp.

Referenced by sis::EigenSorter< T >::compute(), and sis::EigenSorter< T >::EigenSorter().

◆ Mp

template<class T >
bool sis::EigenSorter< T >::Mp

Stores true if machine precision is reached, else false.

Definition at line 3131 of file sis.hpp.

Referenced by sis::EigenSorter< T >::compute().

◆ numMp

template<class T >
int sis::EigenSorter< T >::numMp

Stores number of Chebyshev coefficients in which MP is reached, if not reached, it is set to N+1.

Definition at line 3132 of file sis.hpp.

Referenced by sis::EigenSorter< T >::compute(), and sis::EigenSorter< T >::EigenSorter().


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