Skip to main content

EigsOptions

Struct EigsOptions 

Source
pub struct EigsOptions<T: Real = f64> {
    pub ncv: Option<usize>,
    pub tol: f64,
    pub max_restarts: Option<usize>,
    pub v0: Option<Vec<T>>,
    pub seed: u64,
    pub reorth_eta: f64,
    pub vectors: bool,
    pub allow_partial: bool,
}
Expand description

Options of eigs() and eigsh(). Defaults are scipy’s (scipy.sparse.linalg.eigs/eigsh) where it has one.

Fields§

§ncv: Option<usize>

Krylov dimension; None = min(n, max(2k + 1, 20)). Must satisfy k < ncv ≤ n.

§tol: f64

Relative tolerance of the convergence test (ARPACK’s): a Ritz pair (θ, y) is converged when ‖f‖ |e_jᵀ s| ≤ tol · max(ε^{2/3}, |θ|); 0 (default) means T::EPSILON.

§max_restarts: Option<usize>

Restart limit; None = 10 n (scipy’s maxiter).

§v0: Option<Vec<T>>

Starting vector; None = Gaussian from EigsOptions::seed (Algorithm G), so runs are reproducible.

§seed: u64

Seed of the starting vector and of restarts after an invariant subspace is found (default 0).

§reorth_eta: f64

DGKS threshold (default 1/√2).

§vectors: bool

Compute eigenvectors (default true; scipy’s return_eigenvectors).

§allow_partial: bool

On non-convergence return the converged pairs (Ok, fewer than k) instead of StatlaError::NoConvergence (default false; S10).

Trait Implementations§

Source§

impl<T: Clone + Real> Clone for EigsOptions<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Real> Debug for EigsOptions<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Real> Default for EigsOptions<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<T: PartialEq + Real> PartialEq for EigsOptions<T>

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<T: PartialEq + Real> StructuralPartialEq for EigsOptions<T>

Auto Trait Implementations§

§

impl<T> Freeze for EigsOptions<T>

§

impl<T> RefUnwindSafe for EigsOptions<T>
where T: RefUnwindSafe,

§

impl<T> Send for EigsOptions<T>
where T: Send,

§

impl<T> Sync for EigsOptions<T>
where T: Sync,

§

impl<T> Unpin for EigsOptions<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for EigsOptions<T>

§

impl<T> UnwindSafe for EigsOptions<T>
where T: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.