Struct EigshOptions 

#[non_exhaustive]
pub struct EigshOptions {
    pub eigenpairs: usize,
    pub target: SpectrumTarget,
    pub krylov_dimension: Option<usize>,
    pub tolerance: f64,
    pub max_iterations: usize,
    pub seed: u64,
}

Controls target selection, search-space size, and convergence for eigsh.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

eigenpairs: usize

Number of requested eigenpairs; must be smaller than the dimension.

target: SpectrumTarget

Region of the real Hermitian spectrum to target.

krylov_dimension: Option<usize>

Optional Lanczos or restart window dimension.

tolerance: f64

Required residual norm for convergence.

max_iterations: usize

Maximum Lanczos or restart iteration budget.

seed: u64

Deterministic seed for the initial vector.

Implementations

impl EigshOptions

pub fn new(eigenpairs: usize, target: SpectrumTarget) -> Self

Construct solver controls for an arbitrary spectral target.

pub fn smallest_algebraic(eigenpairs: usize) -> Self

Construct default controls for the algebraically lowest eigenpairs.

pub fn near_shift(eigenpairs: usize, shift: f64) -> Self

Construct default controls for eigenpairs nearest a real shift.

pub fn with_krylov_dimension(self, dimension: usize) -> Self

Set the optional Lanczos or restart window dimension.

pub fn with_tolerance(self, tolerance: f64) -> Self

Set the required residual norm.

pub fn with_max_iterations(self, max_iterations: usize) -> Self

Set the maximum Lanczos or restart iteration budget.

pub fn with_seed(self, seed: u64) -> Self

Set the deterministic initial-vector seed.

Trait Implementations

impl Clone for EigshOptions

fn clone(&self) -> EigshOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EigshOptions

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

Formats the value using the given formatter.

impl PartialEq for EigshOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EigshOptions