Enumeration types for the selection rule of eigenvalues.
More...
|
| enum | Spectra::COMPUTATION_INFO { Spectra::SUCCESSFUL = 0,
Spectra::NOT_COMPUTED,
Spectra::NOT_CONVERGING,
Spectra::NUMERICAL_ISSUE
} |
| |
| enum | Spectra::GEIGS_MODE {
Spectra::GEIGS_CHOLESKY = 0,
Spectra::GEIGS_REGULAR_INVERSE,
Spectra::GEIGS_SHIFT_INVERT,
Spectra::GEIGS_BUCKLING,
Spectra::GEIGS_CAYLEY
} |
| |
| enum | Spectra::SELECT_EIGENVALUE {
Spectra::LARGEST_MAGN = 0,
Spectra::LARGEST_REAL,
Spectra::LARGEST_IMAG,
Spectra::LARGEST_ALGE,
Spectra::SMALLEST_MAGN,
Spectra::SMALLEST_REAL,
Spectra::SMALLEST_IMAG,
Spectra::SMALLEST_ALGE,
Spectra::BOTH_ENDS
} |
| |
| enum | Spectra::SELECT_EIGENVALUE_ALIAS {
Spectra::WHICH_LM = 0,
Spectra::WHICH_LR,
Spectra::WHICH_LI,
Spectra::WHICH_LA,
Spectra::WHICH_SM,
Spectra::WHICH_SR,
Spectra::WHICH_SI,
Spectra::WHICH_SA,
Spectra::WHICH_BE
} |
| |
Enumeration types for the selection rule of eigenvalues.
◆ COMPUTATION_INFO
The enumeration to report the status of computation.
| Enumerator |
|---|
| SUCCESSFUL | Computation was successful.
|
| NOT_COMPUTED | Used in eigen solvers, indicating that computation has not been conducted. Users should call the compute() member function of solvers.
|
| NOT_CONVERGING | Used in eigen solvers, indicating that some eigenvalues did not converge. The compute() function returns the number of converged eigenvalues.
|
| NUMERICAL_ISSUE | Used in Cholesky decomposition, indicating that the matrix is not positive definite.
|
Definition at line 17 of file CompInfo.h.
◆ GEIGS_MODE
The enumeration to specify the mode of generalized eigenvalue solver.
| Enumerator |
|---|
| GEIGS_CHOLESKY | Using Cholesky decomposition to solve generalized eigenvalues.
|
| GEIGS_REGULAR_INVERSE | Regular inverse mode for generalized eigenvalue solver.
|
| GEIGS_SHIFT_INVERT | Shift-and-invert mode for generalized eigenvalue solver.
|
| GEIGS_BUCKLING | Buckling mode for generalized eigenvalue solver.
|
| GEIGS_CAYLEY | Cayley transformation mode for generalized eigenvalue solver.
|
Definition at line 17 of file GEigsMode.h.
◆ SELECT_EIGENVALUE
The enumeration of selection rules of desired eigenvalues.
| Enumerator |
|---|
| LARGEST_MAGN | Select eigenvalues with largest magnitude. Magnitude means the absolute value for real numbers and norm for complex numbers. Applies to both symmetric and general eigen solvers.
|
| LARGEST_REAL | Select eigenvalues with largest real part. Only for general eigen solvers.
|
| LARGEST_IMAG | Select eigenvalues with largest imaginary part (in magnitude). Only for general eigen solvers.
|
| LARGEST_ALGE | Select eigenvalues with largest algebraic value, considering any negative sign. Only for symmetric eigen solvers.
|
| SMALLEST_MAGN | Select eigenvalues with smallest magnitude. Applies to both symmetric and general eigen solvers.
|
| SMALLEST_REAL | Select eigenvalues with smallest real part. Only for general eigen solvers.
|
| SMALLEST_IMAG | Select eigenvalues with smallest imaginary part (in magnitude). Only for general eigen solvers.
|
| SMALLEST_ALGE | Select eigenvalues with smallest algebraic value. Only for symmetric eigen solvers.
|
| BOTH_ENDS | Select eigenvalues half from each end of the spectrum. When nev is odd, compute more from the high end. Only for symmetric eigen solvers.
|
Definition at line 30 of file SelectionRule.h.
◆ SELECT_EIGENVALUE_ALIAS
The enumeration of selection rules of desired eigenvalues. Alias for SELECT_EIGENVALUE.
| Enumerator |
|---|
| WHICH_LM | Alias for LARGEST_MAGN
|
| WHICH_LR | Alias for LARGEST_REAL
|
| WHICH_LI | Alias for LARGEST_IMAG
|
| WHICH_LA | Alias for LARGEST_ALGE
|
| WHICH_SM | Alias for SMALLEST_MAGN
|
| WHICH_SR | Alias for SMALLEST_REAL
|
| WHICH_SI | Alias for SMALLEST_IMAG
|
| WHICH_SA | Alias for SMALLEST_ALGE
|
| WHICH_BE | Alias for BOTH_ENDS
|
Definition at line 62 of file SelectionRule.h.