Skip to main content

RegularizedBoseKernel

Struct RegularizedBoseKernel 

Source
pub struct RegularizedBoseKernel { /* private fields */ }
Expand description

Regularized bosonic analytical continuation kernel

Deprecated: use LogisticKernel, the default kernel for both statistics. RegularizedBoseKernel will be removed in a future release (https://github.com/SpM-lab/sparse-ir-rs/issues/273).

In dimensionless variables x = 2τ/β - 1, y = βω/Λ, the integral kernel is:

K(x, y) = y * exp(-Λ y (x + 1) / 2) / (1 - exp(-Λ y))

This kernel is used for bosonic Green’s functions. The factor y regularizes the singularity at ω = 0, making the kernel well-behaved for numerical work.

The dimensionalized kernel is related by:

K(τ, ω) = ωmax * K(2τ/β - 1, ω/ωmax)

where ωmax = Λ/β.

§Properties

  • Centrosymmetric: K(x, y) = K(-x, -y)
  • ypower = 1: K(x, y) carries one power of y; in physical units K(τ, ω) = ω e^{-τω} / (1 - e^{-βω}) acts on ρ(ω)/ω, i.e. G(τ) = -∫ dω K(τ, ω) ρ(ω)/ω (irbasis paper, Chikano et al., CPC 240, 181 (2019), arXiv:1807.05237, Eqs. (1)-(3))
  • Bosonic only: Does not support fermionic statistics
  • Regularizer: w(β, ω) = ω for bosonic statistics (see regularizer)

§Numerical Stability

The expression v / (exp(v) - 1) is evaluated using expm1 for small |v|.

Implementations§

Source§

impl RegularizedBoseKernel

Source

pub fn new(lambda: f64) -> Result<RegularizedBoseKernel, Error>

👎Deprecated:

use LogisticKernel, the default kernel for both statistics; RegularizedBoseKernel will be removed in a future release (https://github.com/SpM-lab/sparse-ir-rs/issues/273)

Create a new RegularizedBoseKernel

§Arguments
  • lambda - Kernel cutoff Λ (must be positive and finite)
§Errors

Error::InvalidParameter if lambda is not positive and finite. At Λ = 0 the kernel is infinite at y = 0 (K = 1/Λ there), so its SVE does not exist.

Trait Implementations§

Source§

impl AbstractKernel for RegularizedBoseKernel

Source§

fn compute<T>(&self, x: T, y: T) -> T
where T: CustomNumeric + Copy + Debug,

Compute the kernel value K(x, y) with high precision Read more
Source§

fn is_centrosymmetric(&self) -> bool

Check if the kernel is centrosymmetric Read more
Source§

impl CentrosymmKernel for RegularizedBoseKernel

Source§

fn compute_reduced<T>(&self, x: T, y: T, symmetry: SymmetryType) -> T
where T: CustomNumeric + Copy + Debug,

Compute the reduced kernel value Read more
Source§

fn lambda(&self) -> f64

Get the cutoff parameter Λ (lambda)
Source§

impl Clone for RegularizedBoseKernel

Source§

fn clone(&self) -> RegularizedBoseKernel

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for RegularizedBoseKernel

Source§

impl Debug for RegularizedBoseKernel

Source§

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

Formats the value using the given formatter. Read more
Source§

impl KernelProperties for RegularizedBoseKernel

Source§

type SVEHintsType<T: Copy + Debug + Send + Sync + CustomNumeric + 'static> = RegularizedBoseSVEHints<T>

Associated type for SVE hints
Source§

fn ypower(&self) -> i32

Power with which the y coordinate scales. Read more
Source§

fn conv_radius(&self) -> f64

Convergence radius of the Matsubara basis asymptotic model Read more
Source§

fn xmax(&self) -> f64

Get the upper bound of the x domain
Source§

fn ymax(&self) -> f64

Get the upper bound of the y domain
Source§

fn regularizer<S>(&self, _beta: f64, omega: f64) -> f64
where S: StatisticsType + 'static,

A regularizer for a bosonic kernel for avoiding a divergence at omega = 0. Read more
Source§

fn sve_hints<T>( &self, epsilon: f64, ) -> <RegularizedBoseKernel as KernelProperties>::SVEHintsType<T>
where T: Copy + Debug + Send + Sync + CustomNumeric + 'static,

Create SVE hints for this kernel type. Read more
Source§

impl PartialEq for RegularizedBoseKernel

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RegularizedBoseKernel

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> DistributionExt for T
where T: ?Sized,

§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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 more
§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T
where T: Send + Sync,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

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

Checks if self is actually part of its subset T (and can be converted to it).
§

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

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V