Struct rand_distr::SkewNormal

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

The skew normal distribution SN(location, scale, shape).

The skew normal distribution is a generalization of the Normal distribution to allow for non-zero skewness.

It has the density function, for scale > 0, f(x) = 2 / scale * phi((x - location) / scale) * Phi(alpha * (x - location) / scale) where phi and Phi are the density and distribution of a standard normal variable.

Example

use rand_distr::{SkewNormal, Distribution};

// location 2, scale 3, shape 1
let skew_normal = SkewNormal::new(2.0, 3.0, 1.0).unwrap();
let v = skew_normal.sample(&mut rand::thread_rng());
println!("{} is from a SN(2, 3, 1) distribution", v)

Implementation details

We are using the algorithm from A Method to Simulate the Skew Normal Distribution.

Implementations

Construct, from location, scale and shape.

Parameters:

  • location (unrestricted)
  • scale (must be finite and larger than zero)
  • shape (must be finite)

Returns the location of the distribution.

Returns the scale of the distribution.

Returns the shape 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
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

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.