Enum HermitianEigenError 

pub enum HermitianEigenError {
    Empty,
    NonSquare {
        nrows: usize,
        ncols: usize,
    },
    InvalidTolerance {
        tolerance: f64,
    },
    NonHermitian {
        row: usize,
        col: usize,
        difference: f64,
        tolerance: f64,
    },
    DType {
        output: &'static str,
        expected: String,
        actual: String,
    },
    Shape {
        output: &'static str,
        expected: Vec<usize>,
        actual: Vec<usize>,
    },
    NonRealEigenvalue {
        index: usize,
        imaginary: f64,
        tolerance: f64,
    },
    Backend {
        source: Box<dyn Error + Send + Sync + 'static>,
    },
}

Error returned by lowest_hermitian_eigenpair.

The eigensolver is intended for small Rayleigh-Ritz projected matrices; it validates shape and Hermitian structure before calling the backend Hermitian eigendecomposition, symmetrizing only roundoff that is within the requested tolerance. Non-Hermitian effective operators are rejected explicitly instead of silently taking a real part.

Variants

Empty

The matrix has zero rows and columns, so it has no eigenpair.

NonSquare

The input is not square.

Fields

nrows: usize

Number of matrix rows.

ncols: usize

Number of matrix columns.

InvalidTolerance

The Hermitian validation tolerance was negative or not finite.

Fields

tolerance: f64

Rejected tolerance value.

NonHermitian

A matrix entry violates A[i, j] = conj(A[j, i]) within tolerance.

Fields

row: usize

Row of the first offending entry.

col: usize

Column of the first offending entry.

difference: f64

Absolute Hermitian residual for the offending pair.

tolerance: f64

Effective tolerance used for this entry pair.

DType

The backend returned an output with an unexpected dtype.

Fields

output: &'static str

Output tensor name.

expected: String

Expected dtype string.

actual: String

Actual dtype string.

Shape

The backend returned an output with an unexpected shape.

Fields

output: &'static str

Output tensor name.

expected: Vec<usize>

Expected shape.

actual: Vec<usize>

Actual shape.

NonRealEigenvalue

A Hermitian backend eigenvalue had a non-negligible imaginary part.

Fields

index: usize

Eigenvalue position in the backend output.

imaginary: f64

Absolute imaginary part.

tolerance: f64

Tolerance used for validation.

Backend

The tenferro backend rejected or failed the eigendecomposition.

Fields

source: Box<dyn Error + Send + Sync + 'static>

Original backend diagnostic.

Trait Implementations

impl Debug for HermitianEigenError

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

Formats the value using the given formatter.

impl Display for HermitianEigenError

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

Formats the value using the given formatter.

impl Error for HermitianEigenError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.