Struct sprs_rand::rand_distr::LogNormal

pub struct LogNormal<N> { /* 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<N> LogNormal<N> where
    N: Float,
    StandardNormal: Distribution<N>, 

pub fn new(mean: N, std_dev: N) -> Result<LogNormal<N>, Error>

Construct a new LogNormal distribution with the given mean and standard deviation of the logarithm of the distribution.

Trait Implementations

impl<N> Clone for LogNormal<N> where
    N: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N> Copy for LogNormal<N> where
    N: Copy, 

impl<N> Debug for LogNormal<N> where
    N: Debug, 

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

Formats the value using the given formatter.

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

pub fn sample<R>(&self, rng: &mut R) -> N 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.