neco-generalized-eigen
neco-generalized-eigen provides validated public types for generalized eigenvalue problems in no_std + alloc environments. Numerical solvers use its problem data, eigenpairs, mass-orthonormal eigenspaces, mass-metric projectors, convergence states, and complex shifts as their public values.
Public API
GeneralizedEigenProblem: compatible dense stiffness and mass matricesGeneralizedEigenProblem::from_dense: checked dense-problem constructionGeneralizedEigenProblem::from_csr: checked CSR-to-dense conversionEigenResidual: absolute and relative residualEigenpair: validated eigenvalue, vector, and residualEigenspace: a mass-orthonormal basis for one eigenvalue of the given problemEigenProjector: mass-metric eigenspace projectionConvergenceStatus: solver progress metadata, constructible only through validated constructorsEigenShift: finiteComplex<f64>spectral shiftGeneralizedEigenError: validation and linear-algebra failures
Mode counts
requested_modes: count requested from the solver
returned_modes: count in returned eigenspaces
converged_modes: returned count satisfying tolerances
converged_modes <= returned_modes
Converged: converged_modes == returned_modes
The relative residual divides the absolute residual by the largest of the stiffness-product norm, the eigenvalue-scaled mass-product norm, and the minimum positive f64 value.
The solver returns the complete eigenspace of each exactly repeated eigenvalue. Returned and converged counts can exceed the requested count.
Dependencies
neco-linear-types: vector and linear operator typesneco-linear-dense: dense problem matricesneco-sparse: CSR problem-matrix conversionneco-complex: complex spectral shifts
Runtime configuration
The default configuration uses the standard library. Disabling default features selects no_std with alloc.
License
MIT License.