Struct rand::distributions::ChiSquared

[+] Show declaration

pub struct ChiSquared { /* fields omitted */ }

[−] Expand description

The chi-squared distribution χ²(k), where k is the degrees of freedom.

For k > 0 integral, this distribution is the sum of the squares of k independent standard normal random variables. For other k, this uses the equivalent characterisation χ²(k) = Gamma(k/2, 2).

Example

use rand::distributions::{ChiSquared, Distribution};

let chi = ChiSquared::new(11.0);
let v = chi.sample(&mut rand::thread_rng());
println!("{} is from a χ²(11) distribution", v)

Methods

impl ChiSquared

[−]

pub fn new(k: f64) -> ChiSquared

[−]

Create a new chi-squared distribution with degrees-of-freedom k. Panics if k < 0.

Trait Implementations

impl Clone for ChiSquared

[+]

fn clone(&self) -> ChiSquared

[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

[−]

Performs copy-assignment from source.

impl Copy for ChiSquared

impl Debug for ChiSquared

[+]

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

[−]

Formats the value using the given formatter.

impl Distribution<f64> for ChiSquared

[+]

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64

[−]

Generate a random value of T, using rng as the source of randomness.

Important traits for DistIter<'a, D, R, T>

impl<'a, D, R, T> Iterator for DistIter<'a, D, R, T> where
    D: Distribution<T>,
    R: Rng + 'a,  type Item = T;

fn sample_iter<'a, R>(&'a self, rng: &'a mut R) -> DistIter<'a, Self, R, T> where     Self: Sized,     R: Rng,

[−]

Create an iterator that generates random values of T, using rng as the source of randomness.

impl Sample<f64> for ChiSquared

[+]

fn sample<R: Rng>(&mut self, rng: &mut R) -> f64

[−]

Deprecated since 0.5.0

: use Distribution instead

Generate a random value of Support, using rng as the source of randomness.

impl IndependentSample<f64> for ChiSquared

[+]

fn ind_sample<R: Rng>(&self, rng: &mut R) -> f64

[−]

Deprecated since 0.5.0

: use Distribution instead

Generate a random value.