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

Exponential Distribution

Example

let mut exponential = rand_simple::Exponential::new(1192_u32);
// Ensure that the distribution's representation includes the scale parameter
assert_eq!(format!("{exponential}"), "Exp(Scale parameter) = Exp(1)");
// Generate a random number following the Exponential distribution with the initial scale parameter
println!("Returns a random number -> {}", exponential.sample());

// Modify the distribution's scale parameter
let scale: f64 = 1.5_f64;
// Generate a random number following the modified Exponential distribution with scale parameter θ
let result: Result<f64, &str> = exponential.try_set_params(scale);
// Ensure that the distribution's representation includes the scale parameter
assert_eq!(format!("{exponential}"), "Exp(Scale parameter) = Exp(1.5)");
// Generate a random number following the Exponential distribution with the updated scale parameter
println!("Returns a random number -> {}", exponential.sample());

Implementations§

source§

impl Exponential

source

pub fn new(_seed: u32) -> Self

Constructor

  • _seed - Random number seed
source

pub fn sample(&mut self) -> f64

Calculate random numbers.

source

pub fn try_set_params(&mut self, scale: f64) -> Result<f64, &'static str>

Modify the parameters of the probability variable.

  • scale - Scale parameter

Trait Implementations§

source§

impl Display for Exponential

source§

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

Formatter for displaying with macros like println!

  • Scale parameter

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere 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 Twhere 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.