pub struct LanczosParams {
pub basis_size: Option<usize>,
pub max_restarts: usize,
pub tol: f64,
}Expand description
Parameters for the restarted Lanczos eigensolver.
Fields§
§basis_size: Option<usize>Krylov basis vectors held at once. None derives it from the requested
component count as max(2k + 10, k + 20), which leaves enough room
above the wanted pairs for the restart to make progress.
max_restarts: usizeMaximum restart cycles. Each cycle costs one basis worth of matrix-vector products plus the orthogonalisation against the basis, so this is the only knob that bounds the run time.
tol: f64Relative residual tolerance. A Ritz pair counts as converged once
||A x - lambda x|| drops below tol * ||A||. The scaling matters: an
absolute threshold is unreachable for a matrix whose norm is large and
trivially met for one whose norm is tiny.
Implementations§
Source§impl LanczosParams
impl LanczosParams
Sourcepub fn new() -> LanczosParams
pub fn new() -> LanczosParams
Defaults tuned on a single cell diffusion kernel.
§Returns
Self with a derived basis size, 64 restarts and a relative tolerance of
1e-8.
Trait Implementations§
Source§impl Clone for LanczosParams
impl Clone for LanczosParams
Source§fn clone(&self) -> LanczosParams
fn clone(&self) -> LanczosParams
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreimpl Copy for LanczosParams
Source§impl Debug for LanczosParams
impl Debug for LanczosParams
Source§impl Default for LanczosParams
impl Default for LanczosParams
Source§fn default() -> LanczosParams
fn default() -> LanczosParams
Auto Trait Implementations§
impl Freeze for LanczosParams
impl RefUnwindSafe for LanczosParams
impl Send for LanczosParams
impl Sync for LanczosParams
impl Unpin for LanczosParams
impl UnsafeUnpin for LanczosParams
impl UnwindSafe for LanczosParams
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T, U> Imply<T> for U
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.