uni20::krylov::SymmetricEigenParams< Scalar > Struct Template Reference

Common parameters for a symmetric or Hermitian eigenvalue solve. More...

#include <matrix_free.hpp>

Collaboration diagram for uni20::krylov::SymmetricEigenParams< Scalar >:

Public Attributes
Scalar	breakdown_tolerance = Scalar{}
	Relative threshold for declaring Lanczos invariant-subspace breakdown.
bool	compute_eigenvectors = true
KrylovDiagnosticsLevel	diagnostics = KrylovDiagnosticsLevel::None
int	eigenvalue_count = 1
	Number of converged eigenpairs requested by the caller.
int	krylov_dimension = 0
	Maximum Arnoldi/Lanczos subspace dimension.
int	max_iterations = 300
int	retained_ritz_count = 0
	Optional number of Ritz vectors retained internally after restart.
SpectrumPart	spectrum = SpectrumPart::LargestMagnitude
Scalar	tolerance = Scalar{}

Detailed Description

template<uni20::Real Scalar>
struct uni20::krylov::SymmetricEigenParams< Scalar >

Common parameters for a symmetric or Hermitian eigenvalue solve.

Member Data Documentation

breakdown_tolerance

template<uni20::Real Scalar>

Scalar uni20::krylov::SymmetricEigenParams< Scalar >::breakdown_tolerance = Scalar{}

Relative threshold for declaring Lanczos invariant-subspace breakdown.

A value of zero selects a machine-precision default. This is independent of the user Ritz convergence tolerance.

compute_eigenvectors

template<uni20::Real Scalar>

bool uni20::krylov::SymmetricEigenParams< Scalar >::compute_eigenvectors = true

diagnostics

template<uni20::Real Scalar>

KrylovDiagnosticsLevel uni20::krylov::SymmetricEigenParams< Scalar >::diagnostics = KrylovDiagnosticsLevel::None

eigenvalue_count

template<uni20::Real Scalar>

int uni20::krylov::SymmetricEigenParams< Scalar >::eigenvalue_count = 1

Number of converged eigenpairs requested by the caller.

krylov_dimension

template<uni20::Real Scalar>

int uni20::krylov::SymmetricEigenParams< Scalar >::krylov_dimension = 0

Maximum Arnoldi/Lanczos subspace dimension.

max_iterations

template<uni20::Real Scalar>

int uni20::krylov::SymmetricEigenParams< Scalar >::max_iterations = 300

retained_ritz_count

template<uni20::Real Scalar>

int uni20::krylov::SymmetricEigenParams< Scalar >::retained_ritz_count = 0

Optional number of Ritz vectors retained internally after restart.

A value of zero selects retained_ritz_count == eigenvalue_count. Thick-restart paths may set this larger than eigenvalue_count, subject to eigenvalue_count <= retained_ritz_count < krylov_dimension.

spectrum

template<uni20::Real Scalar>

SpectrumPart uni20::krylov::SymmetricEigenParams< Scalar >::spectrum = SpectrumPart::LargestMagnitude

tolerance

template<uni20::Real Scalar>

Scalar uni20::krylov::SymmetricEigenParams< Scalar >::tolerance = Scalar{}

---

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

• matrix_free.hpp