Struct rv::dist::LogNormal

pub struct LogNormal { /* private fields */ }

Expand description

LogNormal Distribution If x ~ Normal(μ, σ), then e^x ~ LogNormal(μ, σ).

Implementations§

impl LogNormal

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

Create a new LogNormal distribution

§Arguments

mu: log scale mean
sigma: log scale standard deviation

pub fn new_unchecked(mu: f64, sigma: f64) -> Self

Creates a new LogNormal without checking whether the parameters are valid.

pub fn standard() -> Self

LogNorma(0, 1)

§Example

let lognormal = LogNormal::standard();
assert_eq!(lognormal, LogNormal::new(0.0, 1.0).unwrap());

pub fn mu(&self) -> f64

Get the mu parameter

§Example

let lognormal = LogNormal::new(-1.0, 2.0).unwrap();
assert_eq!(lognormal.mu(), -1.0);

pub fn set_mu(&mut self, mu: f64) -> Result<(), LogNormalError>

Set the value of mu

§Example

let mut lognormal = LogNormal::new(2.0, 1.5).unwrap();
assert_eq!(lognormal.mu(), 2.0);

lognormal.set_mu(1.3).unwrap();
assert_eq!(lognormal.mu(), 1.3);

Will error for invalid values

assert!(lognormal.set_mu(1.3).is_ok());
assert!(lognormal.set_mu(std::f64::NEG_INFINITY).is_err());
assert!(lognormal.set_mu(std::f64::INFINITY).is_err());
assert!(lognormal.set_mu(std::f64::NAN).is_err());

pub fn set_mu_unchecked(&mut self, mu: f64)

Set the value of mu without input validation

pub fn sigma(&self) -> f64

Get the sigma parameter

§Example

let lognormal = LogNormal::new(-1.0, 2.0).unwrap();
assert_eq!(lognormal.sigma(), 2.0);

pub fn set_sigma(&mut self, sigma: f64) -> Result<(), LogNormalError>

Set the value of sigma

§Example

let mut lognormal = LogNormal::standard();
assert_eq!(lognormal.sigma(), 1.0);

lognormal.set_sigma(2.3).unwrap();
assert_eq!(lognormal.sigma(), 2.3);

Will error for invalid values

assert!(lognormal.set_sigma(2.3).is_ok());
assert!(lognormal.set_sigma(0.0).is_err());
assert!(lognormal.set_sigma(-1.0).is_err());
assert!(lognormal.set_sigma(std::f64::INFINITY).is_err());
assert!(lognormal.set_sigma(std::f64::NEG_INFINITY).is_err());
assert!(lognormal.set_sigma(std::f64::NAN).is_err());

pub fn set_sigma_unchecked(&mut self, sigma: f64)

Set the value of sigma

Trait Implementations§

impl Cdf<f32> for LogNormal

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

The value of the Cumulative Density Function at x Read more

fn sf(&self, x: &X) -> f64

Survival function, 1 - CDF(x)

impl Cdf<f64> for LogNormal

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

The value of the Cumulative Density Function at x Read more

fn sf(&self, x: &X) -> f64

Survival function, 1 - CDF(x)

impl Clone for LogNormal

fn clone(&self) -> LogNormal

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

impl ContinuousDistr<f32> for LogNormal

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

The value of the Probability Density Function (PDF) at x Read more

fn ln_pdf(&self, x: &X) -> f64

The value of the log Probability Density Function (PDF) at x Read more

impl ContinuousDistr<f64> for LogNormal

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

The value of the Probability Density Function (PDF) at x Read more

fn ln_pdf(&self, x: &X) -> f64

The value of the log Probability Density Function (PDF) at x Read more

impl Debug for LogNormal

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

Formats the value using the given formatter. Read more

impl Default for LogNormal

fn default() -> Self

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for LogNormal

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for LogNormal

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

Formats the value using the given formatter. Read more

impl Entropy for LogNormal

fn entropy(&self) -> f64

The entropy, H(X)

impl From<&LogNormal> for String

fn from(lognorm: &LogNormal) -> String

Converts to this type from the input type.

impl InverseCdf<f32> for LogNormal

fn invcdf(&self, p: f64) -> f32

The value of the x at the given probability in the CDF Read more

fn quantile(&self, p: f64) -> X

Alias for invcdf

fn interval(&self, p: f64) -> (X, X)

Interval containing p proportion for the probability Read more

impl InverseCdf<f64> for LogNormal

fn invcdf(&self, p: f64) -> f64

The value of the x at the given probability in the CDF Read more

fn quantile(&self, p: f64) -> X

Alias for invcdf

fn interval(&self, p: f64) -> (X, X)

Interval containing p proportion for the probability Read more

impl Kurtosis for LogNormal

fn kurtosis(&self) -> Option<f64>

impl Mean<f32> for LogNormal

fn mean(&self) -> Option<f32>

Returns None if the mean is undefined

impl Mean<f64> for LogNormal

fn mean(&self) -> Option<f64>

Returns None if the mean is undefined

impl Median<f32> for LogNormal

fn median(&self) -> Option<f32>

Returns None if the median is undefined

impl Median<f64> for LogNormal

fn median(&self) -> Option<f64>

Returns None if the median is undefined

impl Mode<f32> for LogNormal

fn mode(&self) -> Option<f32>

Returns None if the mode is undefined or is not a single value

impl Mode<f64> for LogNormal

fn mode(&self) -> Option<f64>

Returns None if the mode is undefined or is not a single value

impl PartialEq for LogNormal

fn eq(&self, other: &LogNormal) -> 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.

impl Rv<f32> for LogNormal

fn ln_f(&self, x: &f32) -> f64

Probability function Read more

fn draw<R: Rng>(&self, rng: &mut R) -> f32

Single draw from the Rv Read more

fn sample<R: Rng>(&self, n: usize, rng: &mut R) -> Vec<f32>

Multiple draws of the Rv Read more

fn f(&self, x: &X) -> f64

Probability function Read more

fn sample_stream<'r, R: Rng>( &'r self, rng: &'r mut R ) -> Box<dyn Iterator<Item = X> + 'r>

Create a never-ending iterator of samples Read more

impl Rv<f64> for LogNormal

fn ln_f(&self, x: &f64) -> f64

Probability function Read more

fn draw<R: Rng>(&self, rng: &mut R) -> f64

Single draw from the Rv Read more

fn sample<R: Rng>(&self, n: usize, rng: &mut R) -> Vec<f64>

Multiple draws of the Rv Read more

fn f(&self, x: &X) -> f64

Probability function Read more

fn sample_stream<'r, R: Rng>( &'r self, rng: &'r mut R ) -> Box<dyn Iterator<Item = X> + 'r>

Create a never-ending iterator of samples Read more

impl Serialize for LogNormal

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl Skewness for LogNormal

fn skewness(&self) -> Option<f64>

impl Support<f32> for LogNormal

fn supports(&self, x: &f32) -> bool

Returns true if x is in the support of the Rv Read more

impl Support<f64> for LogNormal

fn supports(&self, x: &f64) -> bool

Returns true if x is in the support of the Rv Read more

impl Variance<f64> for LogNormal

fn variance(&self) -> Option<f64>

Returns None if the variance is undefined

impl StructuralPartialEq for LogNormal

Auto Trait Implementations§

impl Freeze for LogNormal

impl RefUnwindSafe for LogNormal

impl Send for LogNormal

impl Sync for LogNormal

impl Unpin for LogNormal

impl UnwindSafe for LogNormal

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<Fx> Rv<Datum> for Fx
where Fx: RvDatum,

fn ln_f(&self, x: &Datum) -> f64

Probability function Read more

fn draw<R>(&self, rng: &mut R) -> Datum
where R: Rng,

Single draw from the Rv Read more

fn sample<R>(&self, n: usize, rng: &mut R) -> Vec<Datum>
where R: Rng,

Multiple draws of the Rv Read more

fn sample_stream<'r, R>( &'r self, rng: &'r mut R ) -> Box<dyn Iterator<Item = Datum> + 'r>
where R: Rng,

Create a never-ending iterator of samples Read more

fn f(&self, x: &X) -> f64

Probability function Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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

fn vzip(self) -> V

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> DeserializeOwnedAlias for T
where T: DeserializeOwned,

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

impl<T> SendAlias for T

impl<T> SendSyncUnwindSafe for T
where T: Send + Sync + UnwindSafe + ?Sized,

impl<T> SerializeAlias for T
where T: Serialize,

impl<T> SyncAlias for T