Gamma

Struct Gamma 

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

Gamma Distribution

§Example

let mut gamma = rand_simple::Gamma::new([1192u32, 765u32, 1543u32]);
assert_eq!(format!("{gamma}"), "Γ(Shape parameter, Scale parameter) = Γ(1, 1)");
println!("Generating a random number following the standard gamma distribution with shape parameter α = 1 and scale parameter β = 1 -> {}", gamma.sample());

// Changing the parameters of the random variable
let shape: f64 = 2f64;
let scale: f64 = 1.5f64;
let result: Result<(f64, f64), &str> = gamma.try_set_params(shape, scale);
assert_eq!(format!("{gamma}"), "Γ(Shape parameter, Scale parameter) = Γ(2, 1.5)");
println!("Generating a random number following the gamma distribution with shape parameter α = {}, and scale parameter β = {} -> {}", shape, scale, gamma.sample());

Implementations§

Source§

impl Gamma

Source

pub fn new(seeds: [u32; 3]) -> Self

Constructs a new instance of the random number generator.

  • seeds - Seeds for the random number generator. Adjusted internally to ensure uniqueness.
Source

pub fn sample(&mut self) -> f64

It computes a random number using the standard gamma distribution.

Source

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

  • shape - Shape parameter
  • scale - Scale parameter

Trait Implementations§

Source§

impl Display for Gamma

Source§

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

Formatter for displaying in macros like print!

  • Shape parameter
  • Scale parameter

Auto Trait Implementations§

§

impl Freeze for Gamma

§

impl RefUnwindSafe for Gamma

§

impl Send for Gamma

§

impl Sync for Gamma

§

impl Unpin for Gamma

§

impl UnwindSafe for Gamma

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