Struct Chi 

pub struct Chi { /* private fields */ }

Chi Distribution

This struct represents the Chi distribution, which is a special case of the gamma distribution with a shape parameter equal to half the degrees of freedom. It is useful in various statistical applications, including hypothesis testing and confidence interval estimation.

Example

let mut chi = rand_simple::Chi::new([1192_u32, 765_u32, 1543_u32, 2003_u32]);

// Verify the initial state
assert_eq!(format!("{chi}"), "χ(Degree of Freedom parameter) = χ(1)");

// Generate a random number from the Chi distribution with 1 degree of freedom
println!("Initial setting: Random number from Chi distribution with 1 degree of freedom -> {}", chi.sample());

// Change the degrees of freedom
let degree_of_freedom: u64 = 2_u64;
let result: Result<u64, &str> = chi.try_set_params(degree_of_freedom);

// Verify the new state
assert_eq!(format!("{chi}"), "χ(Degree of Freedom parameter) = χ(2)");

// Generate a random number from the Chi distribution with the updated degrees of freedom
println!("Updated setting: Random number from Chi distribution with {} degrees of freedom -> {}", degree_of_freedom, chi.sample());

Fields

• xyzuv_u_gamma - State variable for gamma distribution random number generation
• xyzuv_n_0_gamma - State variable for gamma distribution random number generation
• xyzuv_n_1_gamma - State variable for gamma distribution random number generation
• xyzuv_uniform - State variable for uniform distribution random number generation
• degree_of_freedom - Degrees of freedom, must be a positive integer

Implementations

impl Chi

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

Constructor for the Chi struct

Arguments

• seeds - An array of 4 unsigned 32-bit integers used as seeds for the random number generators. The seeds are adjusted to ensure they are unique and suitable for the random number generation.

pub fn sample(&mut self) -> f64

Generates a random number following the Chi distribution.

pub fn try_set_params(&mut self, degree_of_freedom: u64) -> Result<u64, &str>

Updates the parameters of the random variable.

Parameters

• degree_of_freedom - The degrees of freedom r (should be a natural number).

Trait Implementations

impl Display for Chi

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

Formatter for displaying in macros like println!