Struct ndarray_rand::rand_distr::FisherF

pub struct FisherF<F> where
    F: Float,
    StandardNormal: Distribution<F>,
    Exp1: Distribution<F>,
    Open01: Distribution<F>,  { /* fields omitted */ }

The Fisher F distribution F(m, n).

This distribution is equivalent to the ratio of two normalised chi-squared distributions, that is, F(m,n) = (χ²(m)/m) / (χ²(n)/n).

Example

use rand_distr::{FisherF, Distribution};

let f = FisherF::new(2.0, 32.0).unwrap();
let v = f.sample(&mut rand::thread_rng());
println!("{} is from an F(2, 32) distribution", v)

Implementations

impl<F> FisherF<F> where
    F: Float,
    StandardNormal: Distribution<F>,
    Exp1: Distribution<F>,
    Open01: Distribution<F>, 

pub fn new(m: F, n: F) -> Result<FisherF<F>, FisherFError>

Create a new FisherF distribution, with the given parameter.

Trait Implementations

impl<F> Clone for FisherF<F> where
    F: Clone + Float,
    StandardNormal: Distribution<F>,
    Exp1: Distribution<F>,
    Open01: Distribution<F>, 

pub fn clone(&self) -> FisherF<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> Copy for FisherF<F> where
    F: Copy + Float,
    StandardNormal: Distribution<F>,
    Exp1: Distribution<F>,
    Open01: Distribution<F>, 

impl<F> Debug for FisherF<F> where
    F: Debug + Float,
    StandardNormal: Distribution<F>,
    Exp1: Distribution<F>,
    Open01: Distribution<F>, 

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

Formats the value using the given formatter.

impl<F> Distribution<F> for FisherF<F> where
    F: Float,
    StandardNormal: Distribution<F>,
    Exp1: Distribution<F>,
    Open01: Distribution<F>, 

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

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

pub fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
    R: Rng, 

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