Struct rand_simple::PowerFunction

pub struct PowerFunction { /* private fields */ }

Power function distribution

Examples

let mut power_function = rand_simple::PowerFunction::new(1192u32);
assert_eq!(format!("{power_function}"), "PF(Shape parameter γ, Boundary parameter a, Boundary parameter b) = PF(1, 0, 1)");

// If you want to change the parameters of the random variable
let shape: f64 = 2_f64;
let min: f64 = -1_f64;
let max: f64 = 1_f64;
let result: Result<(f64, f64, f64), &str> = power_function.try_set_params(shape, min, max);
assert_eq!(format!("{power_function}"), "PF(Shape parameter γ, Boundary parameter a, Boundary parameter b) = PF(2, -1, 1)");

Implementations

impl PowerFunction

pub fn new(_seed: u32) -> Self

Constructor

• _seed - Random seed

pub fn sample(&mut self) -> f64

Computes a random number

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

Changes the parameters of the probability variable

• shape - Shape parameter γ
• min_a - Lower boundary parameter a
• max_b - Upper boundary parameter b

Trait Implementations

impl Display for PowerFunction

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

Formatter for displaying using println! macro

• Type of the structure
• Scale parameter