Struct Exponential

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

Exponential distribution, Exp(λ) over x in [0, ∞).

§Examples

Compute 50% confidence interval

use rv::prelude::*;

let expon = Exponential::new(1.5).unwrap();
let interval: (f64, f64) = expon.interval(0.5);  // (0.19, 0.92)

Implementations§

Source§

impl Exponential

Source

pub fn new(rate: f64) -> Result<Self, ExponentialError>

Create a new exponential distribution

§Arguments
  • rate: λ > 0, rate or inverse scale
Source

pub fn new_unchecked(rate: f64) -> Self

Creates a new Exponential without checking whether the parameter is valid.

Source

pub fn rate(&self) -> f64

Get the rate parameter

§Example
let expon = Exponential::new(1.3).unwrap();
assert_eq!(expon.rate(), 1.3);
Source

pub fn set_rate(&mut self, rate: f64) -> Result<(), ExponentialError>

Set the rate parameter

§Example
let mut expon = Exponential::new(1.3).unwrap();
assert_eq!(expon.rate(), 1.3);

expon.set_rate(2.1).unwrap();
assert_eq!(expon.rate(), 2.1);

Will error for invalid values

assert!(expon.set_rate(2.1).is_ok());
assert!(expon.set_rate(0.1).is_ok());
assert!(expon.set_rate(0.0).is_err());
assert!(expon.set_rate(-1.0).is_err());
assert!(expon.set_rate(f64::INFINITY).is_err());
assert!(expon.set_rate(f64::NEG_INFINITY).is_err());
assert!(expon.set_rate(f64::NAN).is_err());
Source

pub fn set_rate_unchecked(&mut self, rate: f64)

Set the rate parameter without input validation

Trait Implementations§

Source§

impl Cdf<f32> for Exponential

Source§

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

The value of the Cumulative Density Function at x Read more
Source§

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

Survival function, 1 - CDF(x)
Source§

impl Cdf<f64> for Exponential

Source§

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

The value of the Cumulative Density Function at x Read more
Source§

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

Survival function, 1 - CDF(x)
Source§

impl Clone for Exponential

Source§

fn clone(&self) -> Exponential

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 ContinuousDistr<f32> for Exponential

Source§

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

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

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

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

impl ContinuousDistr<f64> for Exponential

Source§

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

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

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

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

impl Debug for Exponential

Source§

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

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

impl Default for Exponential

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for Exponential

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 Display for Exponential

Source§

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

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

impl Entropy for Exponential

Source§

fn entropy(&self) -> f64

The entropy, H(X)
Source§

impl From<&Exponential> for String

Source§

fn from(expon: &Exponential) -> String

Converts to this type from the input type.
Source§

impl HasDensity<f32> for Exponential

Source§

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

Probability function Read more
Source§

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

Probability function Read more
Source§

impl HasDensity<f64> for Exponential

Source§

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

Probability function Read more
Source§

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

Probability function Read more
Source§

impl InverseCdf<f32> for Exponential

Source§

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

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

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

Alias for invcdf
Source§

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

Interval containing p proportion for the probability Read more
Source§

impl InverseCdf<f64> for Exponential

Source§

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

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

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

Alias for invcdf
Source§

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

Interval containing p proportion for the probability Read more
Source§

impl KlDivergence for Exponential

Source§

fn kl(&self, other: &Self) -> f64

The KL divergence, KL(P|Q) between this distribution, P, and another, Q Read more
Source§

fn kl_sym(&self, other: &Self) -> f64

Symmetrized divergence, KL(P|Q) + KL(Q|P) Read more
Source§

impl Kurtosis for Exponential

Source§

impl Mean<f32> for Exponential

Source§

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

Returns None if the mean is undefined
Source§

impl Mean<f64> for Exponential

Source§

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

Returns None if the mean is undefined
Source§

impl Median<f32> for Exponential

Source§

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

Returns None if the median is undefined
Source§

impl Median<f64> for Exponential

Source§

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

Returns None if the median is undefined
Source§

impl Mode<f32> for Exponential

Source§

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

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

impl Mode<f64> for Exponential

Source§

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

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

impl Parameterized for Exponential

Source§

type Parameters = f64

Source§

fn emit_params(&self) -> Self::Parameters

Source§

fn from_params(rate: Self::Parameters) -> Self

Source§

impl PartialEq for Exponential

Source§

fn eq(&self, other: &Exponential) -> 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 Sampleable<f32> for Exponential

Source§

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

Single draw from the Rv Read more
Source§

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

Multiple draws of the Rv Read more
Source§

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

impl Sampleable<f64> for Exponential

Source§

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

Single draw from the Rv Read more
Source§

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

Multiple draws of the Rv Read more
Source§

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

impl Serialize for Exponential

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§

impl Skewness for Exponential

Source§

impl Support<f32> for Exponential

Source§

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

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

impl Support<f64> for Exponential

Source§

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

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

impl Variance<f32> for Exponential

Source§

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

Returns None if the variance is undefined
Source§

impl Variance<f64> for Exponential

Source§

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

Returns None if the variance is undefined
Source§

impl StructuralPartialEq for Exponential

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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

Source§

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

Source§

impl<S, O, T> Process<S, O> for T
where T: Sampleable<S> + HasDensity<O>,

Source§

impl<X, T> Rv<X> for T
where T: Sampleable<X> + HasDensity<X>,

Source§

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

Source§

impl<T> SendAlias for T

Source§

impl<T> SyncAlias for T