Struct rand_distr::FisherF

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

Expand description

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: Float + Clone, StandardNormal: Distribution<F>, Exp1: Distribution<F>, Open01: Distribution<F>,

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

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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

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

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

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

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

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>
where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more

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

Auto Trait Implementations§

impl<F> Freeze for FisherF<F>
where F: Freeze,

impl<F> RefUnwindSafe for FisherF<F>
where F: RefUnwindSafe,

impl<F> Send for FisherF<F>
where F: Send,

impl<F> Sync for FisherF<F>
where F: Sync,

impl<F> Unpin for FisherF<F>
where F: Unpin,

impl<F> UnwindSafe for FisherF<F>
where F: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V