Struct ndarray_linalg::TruncatedEig

pub struct TruncatedEig<A: Scalar> {
    pub constraints: Option<Array2<A>>,
    /* private fields */
}

Truncated eigenproblem solver

This struct wraps the LOBPCG algorithm and provides convenient builder-pattern access to parameter like maximal iteration, precision and constraint matrix. Furthermore it allows conversion into a iterative solver where each iteration step yields a new eigenvalue/vector pair.

Fields

constraints: Option<Array2<A>>

Implementations

impl<A: Float + Scalar + ScalarOperand + Lapack + PartialOrd + Default> TruncatedEig<A>

pub fn new(problem: Array2<A>, order: Order) -> TruncatedEig<A>

pub fn precision(self, precision: f32) -> Self

pub fn maxiter(self, maxiter: usize) -> Self

pub fn orthogonal_to(self, constraints: Array2<A>) -> Self

pub fn precondition_with(self, preconditioner: Array2<A>) -> Self

pub fn decompose(&self, num: usize) -> LobpcgResult<A>

Trait Implementations

impl<A: Float + Scalar + ScalarOperand + Lapack + PartialOrd + Default> IntoIterator for TruncatedEig<A>

type Item = (ArrayBase<OwnedRepr<A>, Dim<[usize; 1]>>, ArrayBase<OwnedRepr<A>, Dim<[usize; 2]>>)

The type of the elements being iterated over.

type IntoIter = TruncatedEigIterator<A>

Which kind of iterator are we turning this into?

fn into_iter(self) -> TruncatedEigIterator<A>

Creates an iterator from a value.