Struct FloquetSpectrumOptions 

#[non_exhaustive]
pub struct FloquetSpectrumOptions {
    pub eigenpairs: usize,
    pub target_quasienergy: f64,
    pub search_dimension: Option<usize>,
    pub krylov_dimension: Option<usize>,
    pub tolerance: f64,
    pub max_iterations: usize,
    pub seed: u64,
}

Controls a matrix-free Floquet eigensolve near one target quasienergy.

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 returned Floquet eigenpairs.

target_quasienergy: f64

Target quasienergy on the principal branch.

search_dimension: Option<usize>

Candidate phase-filter subspace size before projected unitary diagonalization.

krylov_dimension: Option<usize>

Optional Lanczos restart window used by the Hermitian phase filter.

tolerance: f64

Required Hermitian-filter residual tolerance.

max_iterations: usize

Maximum eigensolver iteration budget.

seed: u64

Deterministic initial-vector seed.

Implementations

impl FloquetSpectrumOptions

pub fn new(eigenpairs: usize, target_quasienergy: f64) -> Self

Construct controls for eigenpairs nearest target_quasienergy.

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

Set the number of phase-filter candidates retained for projected unitary diagonalization.

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

Set the optional Lanczos/restart window.

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

Set the required phase-filter tolerance.

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

Set the maximum eigensolver iteration budget.

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

Set the deterministic initial-vector seed.

Trait Implementations

impl Clone for FloquetSpectrumOptions

fn clone(&self) -> FloquetSpectrumOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FloquetSpectrumOptions

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

Formats the value using the given formatter.

impl PartialEq for FloquetSpectrumOptions

fn eq(&self, other: &FloquetSpectrumOptions) -> 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 FloquetSpectrumOptions