SelectionRule.h File Reference

#include <cmath>
#include <complex>
#include <utility>

Go to the source code of this file.

Enumerations
enum	SELECT_EIGENVALUE {   LARGEST_MAGN = 0,   LARGEST_REAL,   LARGEST_IMAG,   LARGEST_ALGE,   SMALLEST_MAGN,   SMALLEST_REAL,   SMALLEST_IMAG,   SMALLEST_ALGE,   BOTH_ENDS }
enum	SELECT_EIGENVALUE_ALIAS {   WHICH_LM = 0,   WHICH_LR,   WHICH_LI,   WHICH_LA,   WHICH_SM,   WHICH_SR,   WHICH_SI,   WHICH_SA,   WHICH_BE }

Detailed Description

This file defines enumeration types for the selection rule of eigenvalues.

Definition in file SelectionRule.h.

Enumeration Type Documentation

enum 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 17 of file SelectionRule.h.

enum 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 48 of file SelectionRule.h.