Struct statrs::distribution::Normal

pub struct Normal { /* private fields */ }

Implements the Normal distribution

Examples

use statrs::distribution::{Normal, Continuous};
use statrs::statistics::Distribution;

let n = Normal::new(0.0, 1.0).unwrap();
assert_eq!(n.mean().unwrap(), 0.0);
assert_eq!(n.pdf(1.0), 0.2419707245191433497978);

Implementations

impl Normal

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

Constructs a new normal distribution with a mean of mean and a standard deviation of std_dev

Errors

Returns an error if mean or std_dev are NaN or if std_dev <= 0.0

Examples

use statrs::distribution::Normal;

let mut result = Normal::new(0.0, 1.0);
assert!(result.is_ok());

result = Normal::new(0.0, 0.0);
assert!(result.is_err());

Trait Implementations

impl Clone for Normal

fn clone(&self) -> Normal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Continuous<f64, f64> for Normal

fn pdf(&self, x: f64) -> f64

Calculates the probability density function for the normal distribution at x

Formula

(1 / sqrt(2σ^2 * π)) * e^(-(x - μ)^2 / 2σ^2)

where μ is the mean and σ is the standard deviation

fn ln_pdf(&self, x: f64) -> f64

Calculates the log probability density function for the normal distribution at x

Formula

ln((1 / sqrt(2σ^2 * π)) * e^(-(x - μ)^2 / 2σ^2))

where μ is the mean and σ is the standard deviation

impl ContinuousCDF<f64, f64> for Normal

fn cdf(&self, x: f64) -> f64

Calculates the cumulative distribution function for the normal distribution at x

Formula

(1 / 2) * (1 + erf((x - μ) / (σ * sqrt(2))))

where μ is the mean, σ is the standard deviation, and erf is the error function

fn inverse_cdf(&self, x: f64) -> f64

Calculates the inverse cumulative distribution function for the normal distribution at x

Panics

If x < 0.0 or x > 1.0

Formula

μ - sqrt(2) * σ * erfc_inv(2x)

where μ is the mean, σ is the standard deviation and erfc_inv is the inverse of the complementary error function

impl Debug for Normal

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

Formats the value using the given formatter.

impl Distribution<f64> for Normal

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

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<f64> for Normal

fn mean(&self) -> Option<f64>

Returns the mean of the normal distribution

Remarks

This is the same mean used to construct the distribution

fn variance(&self) -> Option<f64>

Returns the variance of the normal distribution

Formula

σ^2

where σ is the standard deviation

fn entropy(&self) -> Option<f64>

Returns the entropy of the normal distribution

Formula

(1 / 2) * ln(2σ^2 * π * e)

where σ is the standard deviation

fn skewness(&self) -> Option<f64>

Returns the skewness of the normal distribution

Formula

0

fn std_dev(&self) -> Option<T>

Returns the standard deviation, if it exists.

impl Max<f64> for Normal

fn max(&self) -> f64

Returns the maximum value in the domain of the normal distribution representable by a double precision float

Formula

INF

impl Median<f64> for Normal

fn median(&self) -> f64

Returns the median of the normal distribution

Formula

μ

where μ is the mean

impl Min<f64> for Normal

fn min(&self) -> f64

Returns the minimum value in the domain of the normal distribution representable by a double precision float

Formula

-INF

impl Mode<Option<f64>> for Normal

fn mode(&self) -> Option<f64>

Returns the mode of the normal distribution

Formula

μ

where μ is the mean

impl PartialEq<Normal> for Normal

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

impl StructuralPartialEq for Normal