Struct LanczosResult 

pub struct LanczosResult<T: Scalar> {
    pub eigenvalue: T::Real,
    pub eigenvector: DenseTensor<T>,
    pub iters: usize,
    pub residual: T::Real,
    pub converged: bool,
}

Output of lanczos_smallest.

Fields

eigenvalue: T::Real

Smallest eigenvalue.

eigenvector: DenseTensor<T>

Corresponding (unit-norm) eigenvector of length dim.

iters: usize

Number of Lanczos iterations actually run.

residual: T::Real

True residual || H v - lambda v ||_2 of the returned pair.

converged: bool

true if the returned pair satisfies the true-residual test || H v - lambda v ||_2 ≤ tol, false otherwise. The cheap Lanczos residual estimate beta * |z[m-1]| and the beta == 0 invariant-subspace check are used as early-exit heuristics inside the iteration loop, but neither sets this flag on its own — the flag comes from comparing the residual the caller sees against tol.

Trait Implementations

impl<T: Clone + Scalar> Clone for LanczosResult<T>

where T::Real: Clone,

fn clone(&self) -> LanczosResult<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Scalar> Debug for LanczosResult<T>

where T::Real: Debug,

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

Formats the value using the given formatter.