ndarray_linalg::lobpcg

Enum LobpcgResult

source
pub enum LobpcgResult<A> {
    Ok(Array1<A>, Array2<A>, Vec<A>),
    Err(Array1<A>, Array2<A>, 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(Array1<A>, Array2<A>, Vec<A>)

§

Err(Array1<A>, Array2<A>, Vec<A>, LinalgError)

§

NoResult(LinalgError)

Trait Implementations§

source§

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

source§

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

Formats the value using the given formatter. Read more

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>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V