Struct rand_distr::Normal

source ·
pub struct Normal<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§

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

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

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.
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> 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> 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,

§

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>,

§

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>,

§

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>,