Struct rand_simple::HalfNormal

source ·
pub struct HalfNormal { /* private fields */ }
Expand description

Half Normal Distribution

Example

let mut half_normal = rand_simple::HalfNormal::new([1192_u32, 765_u32]);
assert_eq!(format!("{half_normal}"), "HN(Std^2) = HN(1^2)");
println!("Returns a random number -> {}", half_normal.sample());

// If you want to change the parameters of the random variable
let variance: f64 = 2_f64;
let result: Result<f64, &str> = half_normal.try_set_params(variance);
assert_eq!(format!("{half_normal}"), "HN(Std^2) = HN(2^2)");
println!("Returns a random number -> {}", half_normal.sample());

Implementations§

source§

impl HalfNormal

source

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

Constructor

  • seeds - Seeds for random number generation. Adjusted on the constructor side to ensure they are not the same.
source

pub fn sample(&mut self) -> f64

Generate a random number.

source

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

Modify the parameters of the random variable.

  • std - Standard deviation

Trait Implementations§

source§

impl Display for HalfNormal

source§

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

Formatter for displaying in functions like println! macro

  • Standard deviation

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

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

§

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.