Enum ndarray_linalg::lobpcg::LobpcgResult

pub enum LobpcgResult<A> {
    Ok(Array1<A>, Array2<A>, Vec<A>),
    Err(Array1<A>, Array2<A>, Vec<A>, LinalgError),
    NoResult(LinalgError),
}

The result of the eigensolver

In the best case the eigensolver has converged with a result better than the given threshold, then a LobpcgResult::Ok gives the eigenvalues, eigenvectors and norms. If an error ocurred during the process, it is returned in LobpcgResult::Err, but the best result is still returned, as it could be usable. If there is no result at all, then LobpcgResult::NoResult is returned. This happens if the algorithm fails in an early stage, for example if the matrix A is not SPD

Variants

Ok

Tuple Fields of Ok

0: Array1<A>1: Array2<A>2: Vec<A>

Err

Tuple Fields of Err

0: Array1<A>1: Array2<A>2: Vec<A>3: LinalgError

NoResult

Tuple Fields of NoResult

0: LinalgError

Trait Implementations

impl<A: Debug> Debug for LobpcgResult<A>

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

Formats the value using the given formatter.