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
Fields§
§ncv: Option<usize>Krylov dimension; None = min(n, max(2k + 1, 20)). Must satisfy
k < ncv ≤ n.
tol: f64Relative 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: u64Seed of the starting vector and of restarts after an invariant subspace is found (default 0).
reorth_eta: f64DGKS threshold (default 1/√2).
vectors: boolCompute eigenvectors (default true; scipy’s
return_eigenvectors).
allow_partial: boolOn non-convergence return the converged pairs (Ok, fewer than
k) instead of StatlaError::NoConvergence (default false;
S10).
Trait Implementations§
Source§impl<T: Real> Default for EigsOptions<T>
impl<T: Real> Default for EigsOptions<T>
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> 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