Struct ndarray_rand::rand_distr::Exp[][src]

pub struct Exp<F> where
    F: Float,
    Exp1: Distribution<F>, 
{ /* fields omitted */ }

The exponential distribution Exp(lambda).

This distribution has density function: f(x) = lambda * exp(-lambda * x) for x > 0, when lambda > 0. For lambda = 0, all samples yield infinity.

Note that Exp1 is an optimised implementation for lambda = 1.

Example

use rand_distr::{Exp, Distribution};

let exp = Exp::new(2.0).unwrap();
let v = exp.sample(&mut rand::thread_rng());
println!("{} is from a Exp(2) distribution", v);

Implementations

impl<F> Exp<F> where
    F: Float,
    Exp1: Distribution<F>, 
[src]

pub fn new(lambda: F) -> Result<Exp<F>, Error>[src]

Construct a new Exp with the given shape parameter lambda.

Remarks

For custom types N implementing the Float trait, the case lambda = 0 is handled as follows: each sample corresponds to a sample from an Exp1 multiplied by 1 / 0. Primitive types yield infinity, since 1 / 0 = infinity.

Trait Implementations

impl<F> Clone for Exp<F> where
    F: Clone + Float,
    Exp1: Distribution<F>, 
[src]

impl<F> Copy for Exp<F> where
    F: Copy + Float,
    Exp1: Distribution<F>, 
[src]

impl<F> Debug for Exp<F> where
    F: Debug + Float,
    Exp1: Distribution<F>, 
[src]

impl<F> Distribution<F> for Exp<F> where
    F: Float,
    Exp1: Distribution<F>, 
[src]

Auto Trait Implementations

impl<F> RefUnwindSafe for Exp<F> where
    F: RefUnwindSafe

impl<F> Send for Exp<F> where
    F: Send

impl<F> Sync for Exp<F> where
    F: Sync

impl<F> Unpin for Exp<F> where
    F: Unpin

impl<F> UnwindSafe for Exp<F> where
    F: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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