Struct rand_distr::Exp

source ·
pub struct Exp<F>
where F: Float, Exp1: Distribution<F>,
{ /* private fields */ }
Expand description

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§

source§

impl<F> Exp<F>
where F: Float, Exp1: Distribution<F>,

source

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

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§

source§

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

source§

fn clone(&self) -> Exp<F>

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

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

source§

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

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

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

source§

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> F

Generate a random value of T, using rng as the source of randomness.
source§

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>
where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness. Read more
source§

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>
where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more
source§

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

Auto Trait Implementations§

§

impl<F> Freeze for Exp<F>
where F: Freeze,

§

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§

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: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

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

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

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

§

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>,

§

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>,

§

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