pub struct MatsubaraSamplingPositiveOnly<S>where
S: StatisticsType,{ /* private fields */ }Expand description
Matsubara sampling for positive frequencies only
Exploits the symmetry G(-iωn) = conj(G(iωn)) of physical Green’s
functions to fit real coefficients from values at non-negative
frequencies. Supports: {0, 1, 2, 3, …} (no negative frequencies)
Implementations§
Source§impl<S> MatsubaraSamplingPositiveOnly<S>where
S: StatisticsType,
impl<S> MatsubaraSamplingPositiveOnly<S>where
S: StatisticsType,
Sourcepub fn new(
basis: &impl Basis<S>,
) -> Result<MatsubaraSamplingPositiveOnly<S>, Error>where
S: 'static,
pub fn new(
basis: &impl Basis<S>,
) -> Result<MatsubaraSamplingPositiveOnly<S>, Error>where
S: 'static,
Create Matsubara sampling with default positive-only sampling points
Uses the default sampling points of the basis (non-negative frequencies only). Exploits symmetry to reconstruct real coefficients.
§Errors
The errors of Basis::default_matsubara_sampling_points
(NotSupported for a DLR or for basis functions without a definite
parity, #183)
Sourcepub fn with_sampling_points(
basis: &impl Basis<S>,
sampling_points: Vec<MatsubaraFreq<S>>,
) -> Result<MatsubaraSamplingPositiveOnly<S>, Error>where
S: 'static,
pub fn with_sampling_points(
basis: &impl Basis<S>,
sampling_points: Vec<MatsubaraFreq<S>>,
) -> Result<MatsubaraSamplingPositiveOnly<S>, Error>where
S: 'static,
Create Matsubara sampling with custom positive-only sampling points
The points may be in any order, and are kept in the given order:
Self::sampling_points returns them unchanged, and index i along the
sampling-point axis of evaluate and fit refers to
sampling_points[i].
Duplicate points are accepted; they only raise the condition number.
§Errors
Error::EmptyInputifsampling_pointsis emptyError::InvalidMatsubaraIndexif a point is negative- The errors of
Basis::evaluate_matsubara
Sourcepub fn from_matrix(
sampling_points: Vec<MatsubaraFreq<S>>,
matrix: &TypedTensor<Complex<f64>, Rank<2>>,
) -> Result<MatsubaraSamplingPositiveOnly<S>, Error>
pub fn from_matrix( sampling_points: Vec<MatsubaraFreq<S>>, matrix: &TypedTensor<Complex<f64>, Rank<2>>, ) -> Result<MatsubaraSamplingPositiveOnly<S>, Error>
Create Matsubara sampling (positive-only) with custom sampling points and pre-computed matrix
This constructor is useful when the sampling matrix is already computed. Uses symmetry to fit real coefficients from complex values at non-negative frequencies.
§Arguments
sampling_points- Matsubara frequency sampling points (must be non-negative), in any ordermatrix- Pre-computed sampling matrix (n_points × basis_size); row i belongs tosampling_points[i]
The points are kept in the given order: Self::sampling_points
returns them unchanged, and index i along the sampling-point axis of
evaluate and fit refers to sampling_points[i].
Duplicate points are accepted; they only raise the condition number.
§Errors
Error::EmptyInputifsampling_pointsis empty, ormatrixhas no columnsError::ShapeMismatchof the input ifmatrixdoes not have one row per pointError::InvalidMatsubaraIndexfor the first negative pointError::NonFiniteInputfor the first entry ofmatrixwith a NaN or infinite part
Sourcepub fn sampling_points(&self) -> &[MatsubaraFreq<S>]
pub fn sampling_points(&self) -> &[MatsubaraFreq<S>]
Get sampling points
Sourcepub fn n_sampling_points(&self) -> usize
pub fn n_sampling_points(&self) -> usize
Number of sampling points
Sourcepub fn basis_size(&self) -> usize
pub fn basis_size(&self) -> usize
Basis size
Sourcepub fn matrix(&self) -> &TypedTensor<Complex<f64>, Rank<2>>
pub fn matrix(&self) -> &TypedTensor<Complex<f64>, Rank<2>>
Get the original complex sampling matrix
Sourcepub fn condition_number(&self) -> Result<f64, Error>
pub fn condition_number(&self) -> Result<f64, Error>
Condition number of the real least-squares problem that fitting solves
Fitting real coefficients x to complex values g at non-negative
frequencies solves [Re A; Im A] x = [Re g; Im g], where A is the
complex n_sampling_points × basis_size matrix Self::matrix. This
returns σ_max / σ_min, the ratio of the largest to the smallest of the
min(2 n_sampling_points, basis_size) singular values of that real
2 n_sampling_points × basis_size matrix; it bounds how much
Self::fit can amplify relative errors in the values. It is not the
condition number of A: with n_sampling_points ≈ basis_size / 2, A
is wide, and its condition number can understate that amplification by
orders of magnitude.
Returns f64::INFINITY if the smallest singular value is below 1e-15
(numerically singular matrix). The singular value decomposition is the
one fitting uses: it is computed by the first call to this method or to
a fit, then cached.
§Errors
Error::DecompositionFailed if the singular value decomposition
fails, which a matrix of finite entries does not cause in practice
(the constructors reject non-finite entries)
Sourcepub fn evaluate(&self, coeffs: &[f64]) -> Result<Vec<Complex<f64>>, Error>
pub fn evaluate(&self, coeffs: &[f64]) -> Result<Vec<Complex<f64>>, Error>
Evaluate basis coefficients at sampling points
§Errors
Error::ShapeMismatchof the input ifcoeffsdoes not have lengthbasis_size
Sourcepub fn fit(&self, values: &[Complex<f64>]) -> Result<Vec<f64>, Error>
pub fn fit(&self, values: &[Complex<f64>]) -> Result<Vec<f64>, Error>
Fit basis coefficients from values at sampling points
§Errors
Error::ShapeMismatchof the input ifvaluesdoes not have lengthn_sampling_pointsError::DecompositionFailedif the singular value decomposition fails
Sourcepub fn evaluate_nd(
&self,
backend: Option<&GemmBackendHandle>,
coeffs: &TypedTensor<f64>,
dim: usize,
) -> Result<TypedTensor<Complex<f64>>, Error>
pub fn evaluate_nd( &self, backend: Option<&GemmBackendHandle>, coeffs: &TypedTensor<f64>, dim: usize, ) -> Result<TypedTensor<Complex<f64>>, Error>
Evaluate N-dimensional array of real basis coefficients at sampling points
§Arguments
coeffs- N-dimensional tensor of real basis coefficientsdim- Dimension along which to evaluate (must have size = basis_size)
§Returns
N-dimensional tensor of complex values at Matsubara frequencies
§Errors
Error::AxisOutOfRangeifdimis not an axis ofcoeffsError::ShapeMismatchof the input ifcoeffsdoes not havebasis_sizealongdim
Sourcepub fn fit_nd(
&self,
backend: Option<&GemmBackendHandle>,
values: &TypedTensor<Complex<f64>>,
dim: usize,
) -> Result<TypedTensor<f64>, Error>
pub fn fit_nd( &self, backend: Option<&GemmBackendHandle>, values: &TypedTensor<Complex<f64>>, dim: usize, ) -> Result<TypedTensor<f64>, Error>
Fit N-dimensional array of complex values to real basis coefficients
§Arguments
backend- Optional GEMM backend handle (None uses default)values- N-dimensional tensor of complex values at Matsubara frequenciesdim- Dimension along which to fit (must have size = n_sampling_points)
§Returns
N-dimensional tensor of real basis coefficients
§Errors
Error::AxisOutOfRangeifdimis not an axis ofvaluesError::ShapeMismatchof the input ifvaluesdoes not haven_sampling_pointsalongdimError::DecompositionFailedif the singular value decomposition fails
Sourcepub fn evaluate_nd_to(
&self,
backend: Option<&GemmBackendHandle>,
coeffs: &TypedTensorView<'_, f64>,
dim: usize,
out: &mut TypedTensorViewMut<'_, Complex<f64>>,
) -> Result<(), Error>
pub fn evaluate_nd_to( &self, backend: Option<&GemmBackendHandle>, coeffs: &TypedTensorView<'_, f64>, dim: usize, out: &mut TypedTensorViewMut<'_, Complex<f64>>, ) -> Result<(), Error>
Evaluate real basis coefficients at Matsubara sampling points (N-dimensional) with in-place output
§Arguments
coeffs- N-dimensional tensor of real coefficients withcoeffs.shape().dim(dim) == basis_sizedim- Dimension along which to evaluate (0-indexed)out- Output tensor without.shape().dim(dim) == n_sampling_points(Complex)
§Errors
Error::AxisOutOfRangeifdimis not an axis ofcoeffsError::ShapeMismatchof the input ifcoeffsdoes not havebasis_sizealongdim, and of the output ifoutdoes not have the shape ofcoeffswithn_sampling_pointsalongdim
Nothing is written to out then.
Sourcepub fn fit_nd_to(
&self,
backend: Option<&GemmBackendHandle>,
values: &TypedTensorView<'_, Complex<f64>>,
dim: usize,
out: &mut TypedTensorViewMut<'_, f64>,
) -> Result<(), Error>
pub fn fit_nd_to( &self, backend: Option<&GemmBackendHandle>, values: &TypedTensorView<'_, Complex<f64>>, dim: usize, out: &mut TypedTensorViewMut<'_, f64>, ) -> Result<(), Error>
Fit N-dimensional complex values to real coefficients with in-place output
§Arguments
values- N-dimensional tensor withvalues.shape().dim(dim) == n_sampling_pointsdim- Dimension along which to fit (0-indexed)out- Output tensor without.shape().dim(dim) == basis_size(f64)
§Errors
Error::AxisOutOfRangeifdimis not an axis ofvaluesError::ShapeMismatchof the input ifvaluesdoes not haven_sampling_pointsalongdim, and of the output ifoutdoes not have the shape ofvalueswithbasis_sizealongdimError::DecompositionFailedif the singular value decomposition fails
Nothing is written to out then.
Trait Implementations§
Source§impl<S> InplaceFitter for MatsubaraSamplingPositiveOnly<S>where
S: StatisticsType,
impl<S> InplaceFitter for MatsubaraSamplingPositiveOnly<S>where
S: StatisticsType,
Source§fn basis_size(&self) -> usize
fn basis_size(&self) -> usize
Source§fn evaluate_nd_dz_to(
&self,
backend: Option<&GemmBackendHandle>,
coeffs: &TypedTensorView<'_, f64>,
dim: usize,
out: &mut TypedTensorViewMut<'_, Complex<f64>>,
) -> Result<(), Error>
fn evaluate_nd_dz_to( &self, backend: Option<&GemmBackendHandle>, coeffs: &TypedTensorView<'_, f64>, dim: usize, out: &mut TypedTensorViewMut<'_, Complex<f64>>, ) -> Result<(), Error>
f64 coefficients to Complex<f64> values.Source§fn evaluate_nd_zz_to(
&self,
backend: Option<&GemmBackendHandle>,
coeffs: &TypedTensorView<'_, Complex<f64>>,
dim: usize,
out: &mut TypedTensorViewMut<'_, Complex<f64>>,
) -> Result<(), Error>
fn evaluate_nd_zz_to( &self, backend: Option<&GemmBackendHandle>, coeffs: &TypedTensorView<'_, Complex<f64>>, dim: usize, out: &mut TypedTensorViewMut<'_, Complex<f64>>, ) -> Result<(), Error>
Complex<f64> coefficients to Complex<f64> values.Source§fn fit_nd_zd_to(
&self,
backend: Option<&GemmBackendHandle>,
values: &TypedTensorView<'_, Complex<f64>>,
dim: usize,
out: &mut TypedTensorViewMut<'_, f64>,
) -> Result<(), Error>
fn fit_nd_zd_to( &self, backend: Option<&GemmBackendHandle>, values: &TypedTensorView<'_, Complex<f64>>, dim: usize, out: &mut TypedTensorViewMut<'_, f64>, ) -> Result<(), Error>
Complex<f64> values to f64 coefficients.Source§fn fit_nd_zz_to(
&self,
backend: Option<&GemmBackendHandle>,
values: &TypedTensorView<'_, Complex<f64>>,
dim: usize,
out: &mut TypedTensorViewMut<'_, Complex<f64>>,
) -> Result<(), Error>
fn fit_nd_zz_to( &self, backend: Option<&GemmBackendHandle>, values: &TypedTensorView<'_, Complex<f64>>, dim: usize, out: &mut TypedTensorViewMut<'_, Complex<f64>>, ) -> Result<(), Error>
Complex<f64> values to Complex<f64> coefficients.Source§fn evaluate_nd_dd_to(
&self,
backend: Option<&GemmBackendHandle>,
coeffs: &TypedTensorView<'_, f64>,
dim: usize,
out: &mut TypedTensorViewMut<'_, f64>,
) -> Result<(), Error>
fn evaluate_nd_dd_to( &self, backend: Option<&GemmBackendHandle>, coeffs: &TypedTensorView<'_, f64>, dim: usize, out: &mut TypedTensorViewMut<'_, f64>, ) -> Result<(), Error>
f64 coefficients to f64 values.Source§fn evaluate_nd_zd_to(
&self,
backend: Option<&GemmBackendHandle>,
coeffs: &TypedTensorView<'_, Complex<f64>>,
dim: usize,
out: &mut TypedTensorViewMut<'_, f64>,
) -> Result<(), Error>
fn evaluate_nd_zd_to( &self, backend: Option<&GemmBackendHandle>, coeffs: &TypedTensorView<'_, Complex<f64>>, dim: usize, out: &mut TypedTensorViewMut<'_, f64>, ) -> Result<(), Error>
Complex<f64> coefficients to f64 values.Source§fn fit_nd_dd_to(
&self,
backend: Option<&GemmBackendHandle>,
values: &TypedTensorView<'_, f64>,
dim: usize,
out: &mut TypedTensorViewMut<'_, f64>,
) -> Result<(), Error>
fn fit_nd_dd_to( &self, backend: Option<&GemmBackendHandle>, values: &TypedTensorView<'_, f64>, dim: usize, out: &mut TypedTensorViewMut<'_, f64>, ) -> Result<(), Error>
f64 values to f64 coefficients.Source§fn fit_nd_dz_to(
&self,
backend: Option<&GemmBackendHandle>,
values: &TypedTensorView<'_, f64>,
dim: usize,
out: &mut TypedTensorViewMut<'_, Complex<f64>>,
) -> Result<(), Error>
fn fit_nd_dz_to( &self, backend: Option<&GemmBackendHandle>, values: &TypedTensorView<'_, f64>, dim: usize, out: &mut TypedTensorViewMut<'_, Complex<f64>>, ) -> Result<(), Error>
f64 values to Complex<f64> coefficients.Auto Trait Implementations§
impl<S> !Freeze for MatsubaraSamplingPositiveOnly<S>
impl<S> !RefUnwindSafe for MatsubaraSamplingPositiveOnly<S>
impl<S> !UnwindSafe for MatsubaraSamplingPositiveOnly<S>
impl<S> Send for MatsubaraSamplingPositiveOnly<S>where
S: Send,
impl<S> Sync for MatsubaraSamplingPositiveOnly<S>where
S: Sync,
impl<S> Unpin for MatsubaraSamplingPositiveOnly<S>where
S: Unpin,
impl<S> UnsafeUnpin for MatsubaraSamplingPositiveOnly<S>
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
§impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> Twhere
Self: Distribution<T>,
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 moreimpl<T> MaybeSend for Twhere
T: Send,
impl<T> MaybeSendSync for T
impl<T> MaybeSync for Twhere
T: Sync,
§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
§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>
self from the equivalent element of its
superset. Read more§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).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.