#[non_exhaustive]pub struct SpectrumOptions {
pub frequencies: Vec<f64>,
pub reference_energy: f64,
pub broadening: f64,
pub krylov_dimension: usize,
pub tolerance: f64,
}Expand description
Frequency grid and Lanczos controls for broadened spectral functions.
Fields (Non-exhaustive)§
This struct is marked as 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.frequencies: Vec<f64>Frequencies at which the response is evaluated.
reference_energy: f64Reference-state energy subtracted from the resolvent.
broadening: f64Positive Lorentzian broadening.
krylov_dimension: usizeMaximum Krylov dimension.
tolerance: f64Continued-fraction termination tolerance.
Implementations§
Source§impl SpectrumOptions
impl SpectrumOptions
Sourcepub fn new(
frequencies: impl Into<Vec<f64>>,
reference_energy: f64,
broadening: f64,
) -> Self
pub fn new( frequencies: impl Into<Vec<f64>>, reference_energy: f64, broadening: f64, ) -> Self
Construct spectral-function controls for a frequency grid.
Sourcepub fn with_krylov_dimension(self, dimension: usize) -> Self
pub fn with_krylov_dimension(self, dimension: usize) -> Self
Set the maximum Krylov dimension.
Sourcepub fn with_tolerance(self, tolerance: f64) -> Self
pub fn with_tolerance(self, tolerance: f64) -> Self
Set the continued-fraction termination tolerance.
Trait Implementations§
Source§impl Clone for SpectrumOptions
impl Clone for SpectrumOptions
Source§fn clone(&self) -> SpectrumOptions
fn clone(&self) -> SpectrumOptions
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for SpectrumOptions
impl Debug for SpectrumOptions
Source§impl PartialEq for SpectrumOptions
impl PartialEq for SpectrumOptions
Source§fn eq(&self, other: &SpectrumOptions) -> bool
fn eq(&self, other: &SpectrumOptions) -> bool
Tests for
self and other values to be equal, and is used by ==.impl StructuralPartialEq for SpectrumOptions
Auto Trait Implementations§
impl Freeze for SpectrumOptions
impl RefUnwindSafe for SpectrumOptions
impl Send for SpectrumOptions
impl Sync for SpectrumOptions
impl Unpin for SpectrumOptions
impl UnsafeUnpin for SpectrumOptions
impl UnwindSafe for SpectrumOptions
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.