Struct rand_simple::Levy

pub struct Levy { /* private fields */ }

Lévy Distribution

Example

// Create a new Lévy distribution with a location parameter (μ) of 0 and a scale parameter (θ) of 1
let mut levy = rand_simple::Levy::new([1192_u32, 765_u32]);
assert_eq!(format!("{levy}"), "Lévy(Location parameter, Scale parameter) = Lévy(0, 1)");
println!("Returns a random number following a standard Levy distribution -> {}", levy.sample());

// Modify the distribution's parameters
let location: f64 = -2_f64;
let scale: f64 = 1.5_f64;
// Update the parameters and generate a random number following the modified Levy distribution
let result: Result<(f64, f64), &str> = levy.try_set_params(location, scale);
assert_eq!(format!("{levy}"), "Lévy(Location parameter, Scale parameter) = Lévy(-2, 1.5)");
println!("Returns a random number following a Levy distribution with location μ = {} and scale θ = {} -> {}", location, scale, levy.sample());

Implementations

impl Levy

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

Constructor

• seeds - Random number seeds. Adjusted internally to ensure uniqueness.

pub fn sample(&mut self) -> f64

Generate a random number.

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

Modify the parameters of the probability variable.

• location - Location parameter
• scale - Scale parameter

Trait Implementations

impl Display for Levy

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

Formatter for use with macros like println!

• Location parameter
• Scale parameter