rand_distr

Struct Normal

Source
pub struct Normal<F>{ /* private fields */ }
Expand description

The Normal distribution N(μ, σ²).

The Normal distribution, also known as the Gaussian distribution or bell curve, is a continuous probability distribution with mean μ (mu) and standard deviation σ (sigma). It is used to model continuous data that tend to cluster around a mean. The Normal distribution is symmetric and characterized by its bell-shaped curve.

See StandardNormal for an optimised implementation for μ = 0 and σ = 1.

§Density function

f(x) = (1 / sqrt(2π σ²)) * exp(-((x - μ)² / (2σ²)))

§Plot

The following diagram shows the Normal distribution with various values of μ and σ. The blue curve is the StandardNormal distribution, N(0, 1).

Normal distribution

§Example

use rand_distr::{Normal, Distribution};

// mean 2, standard deviation 3
let normal = Normal::new(2.0, 3.0).unwrap();
let v = normal.sample(&mut rand::rng());
println!("{} is from a N(2, 9) distribution", v)

§Notes

Implemented via the ZIGNOR variant1 of the Ziggurat method.


  1. Jurgen A. Doornik (2005). An Improved Ziggurat Method to Generate Normal Random Samples. Nuffield College, Oxford 

Implementations§

Source§

impl<F> Normal<F>

Source

pub fn new(mean: F, std_dev: F) -> Result<Normal<F>, Error>

Construct, from mean and standard deviation

Parameters:

  • mean (μ, unrestricted)
  • standard deviation (σ, must be finite)
Source

pub fn from_mean_cv(mean: F, cv: F) -> Result<Normal<F>, Error>

Construct, from mean and coefficient of variation

Parameters:

  • mean (μ, unrestricted)
  • coefficient of variation (cv = abs(σ / μ))
Source

pub fn from_zscore(&self, zscore: F) -> F

Sample from a z-score

This may be useful for generating correlated samples x1 and x2 from two different distributions, as follows.

let mut rng = rand::rng();
let z = StandardNormal.sample(&mut rng);
let x1 = Normal::new(0.0, 1.0).unwrap().from_zscore(z);
let x2 = Normal::new(2.0, -3.0).unwrap().from_zscore(z);
Source

pub fn mean(&self) -> F

Returns the mean (μ) of the distribution.

Source

pub fn std_dev(&self) -> F

Returns the standard deviation (σ) of the distribution.

Trait Implementations§

Source§

impl<F> Clone for Normal<F>

Source§

fn clone(&self) -> Normal<F>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F> Debug for Normal<F>

Source§

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

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

impl<'de, F> Deserialize<'de> for Normal<F>

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<F> Distribution<F> for Normal<F>

Source§

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

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

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. Read more
Source§

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

impl<F> PartialEq for Normal<F>

Source§

fn eq(&self, other: &Normal<F>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<F> Serialize for Normal<F>

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<F> Copy for Normal<F>

Source§

impl<F> StructuralPartialEq for Normal<F>

Auto Trait Implementations§

§

impl<F> Freeze for Normal<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for Normal<F>
where F: RefUnwindSafe,

§

impl<F> Send for Normal<F>
where F: Send,

§

impl<F> Sync for Normal<F>
where F: Sync,

§

impl<F> Unpin for Normal<F>
where F: Unpin,

§

impl<F> UnwindSafe for Normal<F>
where F: UnwindSafe,

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

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

Source§

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

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,