Struct rand_distr::Normal

source ·
pub struct Normal<F>where
    F: Float,
    StandardNormal: Distribution<F>,
{ /* private fields */ }
Expand description

The normal distribution N(mean, std_dev**2).

This uses the ZIGNOR variant of the Ziggurat method, see StandardNormal for more details.

Note that StandardNormal is an optimised implementation for mean 0, and standard deviation 1.

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::thread_rng());
println!("{} is from a N(2, 9) distribution", v)

Implementations§

Construct, from mean and standard deviation

Parameters:

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

Construct, from mean and coefficient of variation

Parameters:

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

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 = thread_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);

Returns the mean (μ) of the distribution.

Returns the standard deviation (σ) of the distribution.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Deserialize this value from the given Serde deserializer. Read more
Generate a random value of T, using rng as the source of randomness.
Create an iterator that generates random values of T, using rng as the source of randomness. Read more
Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.