[−][src]Struct rv::dist::LogNormal
LogNormal Distribution If x ~ Normal(μ, σ), then e^x ~ LogNormal(μ, σ).
Implementations
impl LogNormal
[src]
pub fn new(mu: f64, sigma: f64) -> Result<Self, LogNormalError>
[src]
Create a new LogNormal distribution
Arguments
- mu: log scale mean
- sigma: log scale standard deviation
pub fn new_unchecked(mu: f64, sigma: f64) -> Self
[src]
Creates a new LogNormal without checking whether the parameters are valid.
pub fn standard() -> Self
[src]
LogNorma(0, 1)
Example
let lognormal = LogNormal::standard(); assert_eq!(lognormal, LogNormal::new(0.0, 1.0).unwrap());
pub fn mu(&self) -> f64
[src]
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>
[src]
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)
[src]
Set the value of mu without input validation
pub fn sigma(&self) -> f64
[src]
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>
[src]
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)
[src]
Set the value of sigma
Trait Implementations
impl Cdf<f32> for LogNormal
[src]
impl Cdf<f64> for LogNormal
[src]
impl Clone for LogNormal
[src]
impl ContinuousDistr<f32> for LogNormal
[src]
impl ContinuousDistr<f64> for LogNormal
[src]
impl Debug for LogNormal
[src]
impl Default for LogNormal
[src]
impl Display for LogNormal
[src]
impl Entropy for LogNormal
[src]
impl<'_> From<&'_ LogNormal> for String
[src]
impl InverseCdf<f32> for LogNormal
[src]
fn invcdf(&self, p: f64) -> f32
[src]
fn quantile(&self, p: f64) -> X
[src]
fn interval(&self, p: f64) -> (X, X)
[src]
impl InverseCdf<f64> for LogNormal
[src]
fn invcdf(&self, p: f64) -> f64
[src]
fn quantile(&self, p: f64) -> X
[src]
fn interval(&self, p: f64) -> (X, X)
[src]
impl Kurtosis for LogNormal
[src]
impl Mean<f32> for LogNormal
[src]
impl Mean<f64> for LogNormal
[src]
impl Median<f32> for LogNormal
[src]
impl Median<f64> for LogNormal
[src]
impl Mode<f32> for LogNormal
[src]
impl Mode<f64> for LogNormal
[src]
impl PartialEq<LogNormal> for LogNormal
[src]
impl Rv<f32> for LogNormal
[src]
fn ln_f(&self, x: &f32) -> f64
[src]
fn draw<R: Rng>(&self, rng: &mut R) -> f32
[src]
fn sample<R: Rng>(&self, n: usize, rng: &mut R) -> Vec<f32>
[src]
fn f(&self, x: &X) -> f64
[src]
fn sample_stream<'r, R: Rng>(
&'r self,
rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>
[src]
&'r self,
rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>
impl Rv<f64> for LogNormal
[src]
fn ln_f(&self, x: &f64) -> f64
[src]
fn draw<R: Rng>(&self, rng: &mut R) -> f64
[src]
fn sample<R: Rng>(&self, n: usize, rng: &mut R) -> Vec<f64>
[src]
fn f(&self, x: &X) -> f64
[src]
fn sample_stream<'r, R: Rng>(
&'r self,
rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>
[src]
&'r self,
rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>
impl Skewness for LogNormal
[src]
impl StructuralPartialEq for LogNormal
[src]
impl Support<f32> for LogNormal
[src]
impl Support<f64> for LogNormal
[src]
impl Variance<f64> for LogNormal
[src]
Auto Trait Implementations
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,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<Fx, X> Cdf<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Cdf<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Cdf<X>,
impl<Fx, X> ContinuousDistr<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: ContinuousDistr<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: ContinuousDistr<X>,
impl<Fx> Entropy for Fx where
Fx: Deref,
<Fx as Deref>::Target: Entropy,
[src]
Fx: Deref,
<Fx as Deref>::Target: Entropy,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<Fx, X> InverseCdf<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: InverseCdf<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: InverseCdf<X>,
fn invcdf(&Self, f64) -> X
[src]
fn quantile(&Self, f64) -> X
[src]
fn interval(&Self, f64) -> (X, X)
[src]
impl<Fx> Kurtosis for Fx where
Fx: Deref,
<Fx as Deref>::Target: Kurtosis,
[src]
Fx: Deref,
<Fx as Deref>::Target: Kurtosis,
impl<Fx, X> Mean<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Mean<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Mean<X>,
impl<Fx, X> Median<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Median<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Median<X>,
impl<Fx, X> Mode<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Mode<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Mode<X>,
impl<Fx, X> Rv<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Rv<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Rv<X>,
fn ln_f(&Self, &X) -> f64
[src]
fn f(&Self, &X) -> f64
[src]
fn draw<R>(&Self, &mut R) -> X where
R: Rng,
[src]
R: Rng,
fn sample<R>(&Self, usize, &mut R) -> Vec<X> where
R: Rng,
[src]
R: Rng,
fn sample_stream<'r, R: Rng>(
&'r self,
rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>
[src]
&'r self,
rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<Fx> Skewness for Fx where
Fx: Deref,
<Fx as Deref>::Target: Skewness,
[src]
Fx: Deref,
<Fx as Deref>::Target: Skewness,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn is_in_subset(&self) -> bool
unsafe fn to_subset_unchecked(&self) -> SS
fn from_subset(element: &SS) -> SP
impl<Fx, X> Support<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Support<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Support<X>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
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>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
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>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
fn vzip(self) -> V
impl<Fx, X> Variance<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Variance<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Variance<X>,