Type Alias linfa_linalg::lobpcg::LobpcgResult

pub type LobpcgResult<A> = Result<Lobpcg<A>, (LinalgError, Option<Lobpcg<A>>)>;

The result of the eigensolver

In the best case the eigensolver has converged with a result better than the given threshold, then a Ok gives the eigenvalues, eigenvectors and norms. If an error ocurred during the process, it is returned in Err (together with the best result), as it could be of value. If there is no result at all, then the second field is None. This happens if the algorithm fails in an early stage, for example if the matrix A is not SPD

Aliased Type

enum LobpcgResult<A> {
    Ok(Lobpcg<A>),
    Err((LinalgError, Option<Lobpcg<A>>)),
}

Variants

Ok(Lobpcg<A>)

Contains the success value

Err((LinalgError, Option<Lobpcg<A>>))

Contains the error value