Struct lattice_qcd_rs::statistics::distribution::CloseToUnit

pub struct CloseToUnit { /* private fields */ }

used to generates matrix close the unit, for su2 close to +/-1, see su2::random_su2_close_to_unity and for su(3) [su3::get_r] (+/- 1) * [su3::get_s] (+/- 1) * [su3::get_t] (+/- 1)

Example

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

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

Implementations

impl CloseToUnit

pub const fn spread_parameter(&self) -> f64

Get the spread parameter

pub fn new(spread_parameter: Real) -> Option<Self>

Create a new distribution, spread_parameter should be in (0,1) 0 and 1 excluded

Trait Implementations

impl Clone for CloseToUnit

fn clone(&self) -> CloseToUnit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CloseToUnit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CloseToUnit

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

Deserialize this value from the given Serde deserializer.

impl Display for CloseToUnit

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 CloseToUnit

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 Distribution<Matrix<Complex<f64>, Const<3>, Const<3>, ArrayStorage<Complex<f64>, 3, 3>>> for CloseToUnit

fn sample<R>(&self, rng: &mut R) -> CMatrix3where 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 PartialEq<CloseToUnit> for CloseToUnit

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

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

Serialize this value into the given Serde serializer.

impl Copy for CloseToUnit

impl StructuralPartialEq for CloseToUnit