Struct lattice_qcd_rs::statistics::distribution::HeatBathDistribution

pub struct HeatBathDistribution<T>where
    T: One + Div<T, Output = T> + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Neg<Output = T> + Float + FloatConst + Zero + SampleUniform + PartialOrd,
    OpenClosed01: Distribution<T>,
    Uniform<T>: Distribution<T>,{ /* private fields */ }

Distribution for the Heat Bath methods with the parameter param_exp = beta * sqrt(det(A)).

With distribution dP(X) = 1/(2 \pi^2) d \cos(\theta) d\phi dx_0 \sqrt(1-x_0^2) e^{param_exp x_0}.

Example

use lattice_qcd_rs::error::ImplementationError;
use lattice_qcd_rs::statistics::HeatBathDistribution;
use nalgebra::{Complex, Matrix2};
use rand::{Rng, SeedableRng};

let mut rng = rand::rngs::StdRng::seed_from_u64(0);
let heat_bath =
    HeatBathDistribution::new(0.5_f64).ok_or(ImplementationError::OptionWithUnexpectedNone)?;
let r_matrix: Matrix2<Complex<f64>> = rng.sample(&heat_bath);

Implementations

impl<T> HeatBathDistribution<T>where T: One + Div<T, Output = T> + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Neg<Output = T> + Float + FloatConst + Zero + SampleUniform + PartialOrd, OpenClosed01: Distribution<T>, Uniform<T>: Distribution<T>,

pub const fn param_exp(&self) -> T

Returns the parameter param_exp.

pub fn new(param_exp: T) -> Option<Self>

Create the distribution. param_exp should be strictly greater than 0 an be finite and a number. Otherwise return None.

Trait Implementations

impl<T> Clone for HeatBathDistribution<T>where T: One + Div<T, Output = T> + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Neg<Output = T> + Float + FloatConst + Zero + SampleUniform + PartialOrd + Clone, OpenClosed01: Distribution<T>, Uniform<T>: Distribution<T>,

fn clone(&self) -> HeatBathDistribution<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for HeatBathDistribution<T>where T: One + Div<T, Output = T> + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Neg<Output = T> + Float + FloatConst + Zero + SampleUniform + PartialOrd + Debug, OpenClosed01: Distribution<T>, Uniform<T>: Distribution<T>,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for HeatBathDistribution<T>where T: One + Div<T, Output = T> + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Neg<Output = T> + Float + FloatConst + Zero + SampleUniform + PartialOrd + Deserialize<'de>, OpenClosed01: Distribution<T>, Uniform<T>: Distribution<T>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for HeatBathDistribution<T>where T: One + Div<T, Output = T> + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Neg<Output = T> + Float + FloatConst + Zero + SampleUniform + PartialOrd + Display, OpenClosed01: Distribution<T>, Uniform<T>: Distribution<T>,

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

Formats the value using the given formatter.

impl Distribution<Matrix<Complex<f64>, Const<2>, Const<2>, ArrayStorage<Complex<f64>, 2, 2>>> for HeatBathDistribution<f64>

fn sample<R>(&self, rng: &mut R) -> CMatrix2where R: Rng + ?Sized,

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl<T> Hash for HeatBathDistribution<T>where T: One + Div<T, Output = T> + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Neg<Output = T> + Float + FloatConst + Zero + SampleUniform + PartialOrd + Hash, OpenClosed01: Distribution<T>, Uniform<T>: Distribution<T>,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> PartialEq<HeatBathDistribution<T>> for HeatBathDistribution<T>where T: One + Div<T, Output = T> + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Neg<Output = T> + Float + FloatConst + Zero + SampleUniform + PartialOrd + PartialEq, OpenClosed01: Distribution<T>, Uniform<T>: Distribution<T>,

fn eq(&self, other: &HeatBathDistribution<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Serialize for HeatBathDistribution<T>where T: One + Div<T, Output = T> + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Neg<Output = T> + Float + FloatConst + Zero + SampleUniform + PartialOrd + Serialize, OpenClosed01: Distribution<T>, Uniform<T>: Distribution<T>,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Copy for HeatBathDistribution<T>where T: One + Div<T, Output = T> + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Neg<Output = T> + Float + FloatConst + Zero + SampleUniform + PartialOrd + Copy, OpenClosed01: Distribution<T>, Uniform<T>: Distribution<T>,

impl<T> Eq for HeatBathDistribution<T>where T: One + Div<T, Output = T> + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Neg<Output = T> + Float + FloatConst + Zero + SampleUniform + PartialOrd + Eq, OpenClosed01: Distribution<T>, Uniform<T>: Distribution<T>,

impl<T> StructuralEq for HeatBathDistribution<T>where T: One + Div<T, Output = T> + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Neg<Output = T> + Float + FloatConst + Zero + SampleUniform + PartialOrd, OpenClosed01: Distribution<T>, Uniform<T>: Distribution<T>,

impl<T> StructuralPartialEq for HeatBathDistribution<T>where T: One + Div<T, Output = T> + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Neg<Output = T> + Float + FloatConst + Zero + SampleUniform + PartialOrd, OpenClosed01: Distribution<T>, Uniform<T>: Distribution<T>,