# Struct rand_distr::LogNormal

``````pub struct LogNormal<F>where
F: Float,
StandardNormal: Distribution<F>,{ /* private fields */ }``````
Expand description

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();
println!("{} is from an ln N(2, 9) distribution", v)``````

## Implementations§

source§

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

source

#### 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
source

#### 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`).

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 = 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§

source§

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

source§

#### fn clone(&self) -> LogNormal<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 LogNormal<F>where F: Float + Debug, StandardNormal: Distribution<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 LogNormal<F>where F: Float + Deserialize<'de>, StandardNormal: Distribution<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 LogNormal<F>where F: Float, StandardNormal: Distribution<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<LogNormal<F>> for LogNormal<F>where F: Float + PartialEq, StandardNormal: Distribution<F>,

source§

#### fn eq(&self, other: &LogNormal<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 LogNormal<F>where F: Float + Serialize, StandardNormal: Distribution<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§

source§

§

§

§

§

§

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere 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 Twhere 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 Twhere 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§

source§

source§