Struct ndarray_rand::rand_distr::LogNormal

pub struct LogNormal<F> where
    F: Float,
    StandardNormal: Distribution<F>,  { /* fields omitted */ }

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

If X is log-normal distributed, then ln(X) is N(mean, std_dev**2) distributed.

Example

use rand_distr::{LogNormal, Distribution};

// mean 2, standard deviation 3
let log_normal = LogNormal::new(2.0, 3.0).unwrap();
let v = log_normal.sample(&mut rand::thread_rng());
println!("{} is from an ln N(2, 9) distribution", v)

Implementations

impl<F> LogNormal<F> where
    F: Float,
    StandardNormal: Distribution<F>, 

pub fn new(mu: F, sigma: F) -> Result<LogNormal<F>, Error>

Construct, from (log-space) mean and standard deviation

Parameters are the “standard” log-space measures (these are the mean and standard deviation of the logarithm of samples):

• mu (μ, unrestricted) is the mean of the underlying distribution
• sigma (σ, must be finite) is the standard deviation of the underlying Normal distribution

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

Construct, from (linear-space) mean and coefficient of variation

Parameters are linear-space measures:

• mean (μ > 0) is the (real) mean of the distribution
• coefficient of variation (cv = σ / μ, requiring cv ≥ 0) is a standardized measure of dispersion

As a special exception, μ = 0, cv = 0 is allowed (samples are -inf).

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 = LogNormal::from_mean_cv(3.0, 1.0).unwrap().from_zscore(z);
let x2 = LogNormal::from_mean_cv(2.0, 4.0).unwrap().from_zscore(z);

Trait Implementations

impl<F> Clone for LogNormal<F> where
    F: Clone + Float,
    StandardNormal: Distribution<F>, 

pub fn clone(&self) -> LogNormal<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> Copy for LogNormal<F> where
    F: Copy + Float,
    StandardNormal: Distribution<F>, 

impl<F> Debug for LogNormal<F> where
    F: Debug + Float,
    StandardNormal: Distribution<F>, 

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

Formats the value using the given formatter.

impl<F> Distribution<F> for LogNormal<F> where
    F: Float,
    StandardNormal: Distribution<F>, 

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

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

pub fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
    R: Rng, 

Create an iterator that generates random values of T, using rng as the source of randomness.