Struct rand_simple::Cauchy

pub struct Cauchy { /* private fields */ }

Cauchy Distribution

Example

let mut cauchy = rand_simple::Cauchy::new(1192_u32);
assert_eq!(format!("{cauchy}"), "Ca(Location parameter, Scale parameter) = Ca(0, 1)");
println!("Returns a random number -> {}", cauchy.sample());

// When changing the parameters of the random variable
let location: f64 = -2_f64;
let scale: f64 = 1.5_f64;
let result: Result<(f64, f64), &str> = cauchy.try_set_params(location, scale);
assert_eq!(format!("{cauchy}"), "Ca(Location parameter, Scale parameter) = Ca(-2, 1.5)");
println!("Returns a random number -> {}", cauchy.sample());

Implementations

impl Cauchy

pub fn new(_seed: u32) -> Self

Constructor

• _seed - Random seed to initialize the generator.

pub fn sample(&mut self) -> f64

Calculate a random number.

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

Modify the parameters of the random variable.

• location - Location parameter
• scale - Scale parameter

Trait Implementations

impl Display for Cauchy

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

Formatter for displaying in macros like print!

• Location parameter
• Scale parameter