Struct ndarray_linalg::TruncatedEig[−][src]

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

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>`[src]

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

`pub fn precision(self, precision: f32) -> Self`[src]

`pub fn maxiter(self, maxiter: usize) -> Self`[src]

`pub fn orthogonal_to(self, constraints: Array2<A>) -> Self`[src]

`pub fn precondition_with(self, preconditioner: Array2<A>) -> Self`[src]

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

Trait Implementations

`impl<A: Float + Scalar + ScalarOperand + Lapack + PartialOrd + Default> IntoIterator for TruncatedEig<A>`[src]

`type Item = (Array1<A>, Array2<A>)`

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>`[src]

Auto Trait Implementations

`impl<A> RefUnwindSafe for TruncatedEig<A> where A: RefUnwindSafe,`

`impl<A> Send for TruncatedEig<A> where A: Send,`

`impl<A> Sync for TruncatedEig<A> where A: Sync,`

`impl<A> Unpin for TruncatedEig<A>`

`impl<A> UnwindSafe for TruncatedEig<A> where A: RefUnwindSafe,`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`pub fn try_into(self) -> Result<U, >::Error>`[src]

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

`pub fn vzip(self) -> V`

Struct ndarray_linalg::TruncatedEig[−][src]

Fields

Implementations

`impl<A: Float + Scalar + ScalarOperand + Lapack + PartialOrd + Default> TruncatedEig<A>`[src]

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

`pub fn precision(self, precision: f32) -> Self`[src]

`pub fn maxiter(self, maxiter: usize) -> Self`[src]

`pub fn orthogonal_to(self, constraints: Array2<A>) -> Self`[src]

`pub fn precondition_with(self, preconditioner: Array2<A>) -> Self`[src]

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

Trait Implementations

`impl<A: Float + Scalar + ScalarOperand + Lapack + PartialOrd + Default> IntoIterator for TruncatedEig<A>`[src]

`type Item = (Array1<A>, Array2<A>)`

`type IntoIter = TruncatedEigIterator<A>`

`fn into_iter(self) -> TruncatedEigIterator<A>`[src]

Auto Trait Implementations

`impl<A> RefUnwindSafe for TruncatedEig<A> where A: RefUnwindSafe,`

`impl<A> Send for TruncatedEig<A> where A: Send,`

`impl<A> Sync for TruncatedEig<A> where A: Sync,`

`impl<A> Unpin for TruncatedEig<A>`

`impl<A> UnwindSafe for TruncatedEig<A> where A: RefUnwindSafe,`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

`pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

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

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

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

`pub fn vzip(self) -> V`

Struct ndarray_linalg::TruncatedEig[−][src]

Fields

Implementations

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

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

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

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

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

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

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

Trait Implementations

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

type Item = (Array1<A>, Array2<A>)

type IntoIter = TruncatedEigIterator<A>

fn into_iter(self) -> TruncatedEigIterator<A>[src]

Auto Trait Implementations

impl<A> RefUnwindSafe for TruncatedEig<A> where A: RefUnwindSafe,

impl<A> Send for TruncatedEig<A> where A: Send,

impl<A> Sync for TruncatedEig<A> where A: Sync,

impl<A> Unpin for TruncatedEig<A>

impl<A> UnwindSafe for TruncatedEig<A> where A: RefUnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

pub fn into(self) -> U[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

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

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

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

pub fn vzip(self) -> V

`impl<A: Float + Scalar + ScalarOperand + Lapack + PartialOrd + Default> TruncatedEig<A>`[src]

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

`pub fn precision(self, precision: f32) -> Self`[src]

`pub fn maxiter(self, maxiter: usize) -> Self`[src]

`pub fn orthogonal_to(self, constraints: Array2<A>) -> Self`[src]

`pub fn precondition_with(self, preconditioner: Array2<A>) -> Self`[src]

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

`impl<A: Float + Scalar + ScalarOperand + Lapack + PartialOrd + Default> IntoIterator for TruncatedEig<A>`[src]

`type Item = (Array1<A>, Array2<A>)`

`type IntoIter = TruncatedEigIterator<A>`

`fn into_iter(self) -> TruncatedEigIterator<A>`[src]

`impl<A> RefUnwindSafe for TruncatedEig<A> where A: RefUnwindSafe,`

`impl<A> Send for TruncatedEig<A> where A: Send,`

`impl<A> Sync for TruncatedEig<A> where A: Sync,`

`impl<A> Unpin for TruncatedEig<A>`

`impl<A> UnwindSafe for TruncatedEig<A> where A: RefUnwindSafe,`

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

`pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

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

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

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

`pub fn vzip(self) -> V`