Skip to main content

LogNormal

Struct LogNormal 

Source
pub struct LogNormal { /* private fields */ }
Expand description

Log-normal distribution: if X ~ LogNormal(μ, σ), then ln(X) ~ N(μ, σ²).

§Mathematical Definition

  • PDF: (1/(xσ√(2π))) exp(−(ln(x)−μ)²/(2σ²)) for x > 0
  • CDF: Φ((ln(x)−μ)/σ)
  • Mean: exp(μ + σ²/2)
  • Variance: (exp(σ²) − 1) · exp(2μ + σ²)

Reference: Johnson, Kotz & Balakrishnan (1994), Continuous Univariate Distributions, Vol. 1, Chapter 14.

Implementations§

Source§

impl LogNormal

Source

pub fn new(mu: f64, sigma: f64) -> Result<Self, DistributionError>

Creates a new log-normal distribution.

Parameters mu and sigma are the mean and std dev of ln(X).

§Errors

Returns Err if sigma ≤ 0 or parameters are not finite.

Source

pub fn mu(&self) -> f64

Source

pub fn sigma(&self) -> f64

Source

pub fn mean(&self) -> f64

Mean = exp(μ + σ²/2).

Source

pub fn variance(&self) -> f64

Variance = (exp(σ²) − 1) · exp(2μ + σ²).

Source

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

PDF for x > 0.

Source

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

CDF: Φ((ln(x)−μ)/σ) for x > 0.

Source

pub fn quantile(&self, p: f64) -> Option<f64>

Inverse CDF: exp(μ + σ·Φ⁻¹(p)).

Returns None if p is outside (0, 1).

Trait Implementations§

Source§

impl Clone for LogNormal

Source§

fn clone(&self) -> LogNormal

Returns a duplicate 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 Debug for LogNormal

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for LogNormal

Source§

fn eq(&self, other: &LogNormal) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for LogNormal

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 T
where 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 T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V