Struct LanczosResult 

pub struct LanczosResult {
    pub eigenvalues: Vec<f64>,
    pub eigenvectors: Vec<Vec<f32>>,
    pub residual: f64,
    pub norm_estimate: f64,
    pub converged: bool,
    pub restarts: usize,
}

Outcome of a restarted Lanczos solve, with the convergence diagnostics.

The diagnostics exist because a budget-exhausted solve and a converged one are otherwise indistinguishable from the outside, and the difference is several digits of accuracy in the eigenvalues.

Fields

eigenvalues: Vec<f64>

Eigenvalues sorted descending. Kept in f64 because the callers form lambda / (1 - lambda), which is catastrophic in f32 once lambda approaches one, as it does for any diffusion operator.

eigenvectors: Vec<Vec<f32>>

eigenvectors[i][j] is element i of eigenvector j. Always exactly eigenvalues.len() columns wide.

residual: f64

Largest residual ||A x - lambda x|| over the returned pairs.

norm_estimate: f64

Scale the residual was tested against, i.e. the ||A|| estimate.

converged: bool

Whether residual met tol * norm_estimate.

restarts: usize

Restart cycles actually run.

Trait Implementations

impl Clone for LanczosResult

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LanczosResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.