pub enum LobpcgResult<A> {
Ok(ArrayBase<OwnedRepr<A>, Dim<[usize; 1]>>, ArrayBase<OwnedRepr<A>, Dim<[usize; 2]>>, Vec<A>),
Err(ArrayBase<OwnedRepr<A>, Dim<[usize; 1]>>, ArrayBase<OwnedRepr<A>, Dim<[usize; 2]>>, Vec<A>, LinalgError),
NoResult(LinalgError),
}Expand description
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(ArrayBase<OwnedRepr<A>, Dim<[usize; 1]>>, ArrayBase<OwnedRepr<A>, Dim<[usize; 2]>>, Vec<A>)
Err(ArrayBase<OwnedRepr<A>, Dim<[usize; 1]>>, ArrayBase<OwnedRepr<A>, Dim<[usize; 2]>>, Vec<A>, LinalgError)
NoResult(LinalgError)
Trait Implementations§
Auto Trait Implementations§
impl<A> Freeze for LobpcgResult<A>
impl<A> RefUnwindSafe for LobpcgResult<A>where
A: RefUnwindSafe,
impl<A> Send for LobpcgResult<A>where
A: Send,
impl<A> Sync for LobpcgResult<A>where
A: Sync,
impl<A> Unpin for LobpcgResult<A>where
A: Unpin,
impl<A> UnwindSafe for LobpcgResult<A>where
A: RefUnwindSafe + UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.