Struct rand_simple::Rayleigh

pub struct Rayleigh { /* private fields */ }

Rayleigh distribution.

Examples

let mut rayleigh = rand_simple::Rayleigh::new(1192u32);
assert_eq!(format!("{rayleigh}"), "Rayleigh(Scale parameter) = Rayleigh(1)");

// To change the parameter of the random variable
let scale: f64 = 1.5f64;
let result: Result<f64, &str> = rayleigh.try_set_params(scale);
assert_eq!(format!("{rayleigh}"), "Rayleigh(Scale parameter) = Rayleigh(1.5)");

Implementations

impl Rayleigh

pub fn new(_seed: u32) -> Self

Constructor for initializing a new random number generator.

• _seed - The seed for the random number generator.

pub fn sample(&mut self) -> f64

Generate a random sample.

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

Modify the parameters of the probability variable.

• scale - Scale parameter

Trait Implementations

impl Display for Rayleigh

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

Implements the Display trait for the Rayleigh struct. This allows the struct to be formatted and displayed using macros like println! It displays information about the scale parameter.