Struct statrs::distribution::FisherSnedecor [−][src]
pub struct FisherSnedecor { /* fields omitted */ }
Expand description
Implements the Fisher-Snedecor distribution also commonly known as the F-distribution
Examples
use statrs::distribution::{FisherSnedecor, Continuous}; use statrs::statistics::Distribution; use statrs::prec; let n = FisherSnedecor::new(3.0, 3.0).unwrap(); assert_eq!(n.mean().unwrap(), 3.0); assert!(prec::almost_eq(n.pdf(1.0), 0.318309886183790671538, 1e-15));
Implementations
impl FisherSnedecor
[src]
impl FisherSnedecor
[src]pub fn new(freedom_1: f64, freedom_2: f64) -> Result<FisherSnedecor>
[src]
pub fn new(freedom_1: f64, freedom_2: f64) -> Result<FisherSnedecor>
[src]Constructs a new fisher-snedecor distribution with
degrees of freedom freedom_1
and freedom_2
Errors
Returns an error if freedom_1
or freedom_2
are NaN
.
Also returns an error if freedom_1 <= 0.0
or freedom_2 <= 0.0
Examples
use statrs::distribution::FisherSnedecor; let mut result = FisherSnedecor::new(1.0, 1.0); assert!(result.is_ok()); result = FisherSnedecor::new(0.0, 0.0); assert!(result.is_err());
Trait Implementations
impl Clone for FisherSnedecor
[src]
impl Clone for FisherSnedecor
[src]fn clone(&self) -> FisherSnedecor
[src]
fn clone(&self) -> FisherSnedecor
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Continuous<f64, f64> for FisherSnedecor
[src]
impl Continuous<f64, f64> for FisherSnedecor
[src]fn pdf(&self, x: f64) -> f64
[src]
fn pdf(&self, x: f64) -> f64
[src]Calculates the probability density function for the fisher-snedecor
distribution
at x
Remarks
Returns NaN
if freedom_1
, freedom_2
is INF
, or x
is +INF
or
-INF
Formula
sqrt(((d1 * x) ^ d1 * d2 ^ d2) / (d1 * x + d2) ^ (d1 + d2)) / (x * β(d1 / 2, d2 / 2))
where d1
is the first degree of freedom, d2
is
the second degree of freedom, and β
is the beta function
fn ln_pdf(&self, x: f64) -> f64
[src]
fn ln_pdf(&self, x: f64) -> f64
[src]Calculates the log probability density function for the fisher-snedecor
distribution
at x
Remarks
Returns NaN
if freedom_1
, freedom_2
is INF
, or x
is +INF
or
-INF
Formula
ln(sqrt(((d1 * x) ^ d1 * d2 ^ d2) / (d1 * x + d2) ^ (d1 + d2)) / (x * β(d1 / 2, d2 / 2)))
where d1
is the first degree of freedom, d2
is
the second degree of freedom, and β
is the beta function
impl ContinuousCDF<f64, f64> for FisherSnedecor
[src]
impl ContinuousCDF<f64, f64> for FisherSnedecor
[src]fn cdf(&self, x: f64) -> f64
[src]
fn cdf(&self, x: f64) -> f64
[src]Calculates the cumulative distribution function for the fisher-snedecor
distribution
at x
Formula
I_((d1 * x) / (d1 * x + d2))(d1 / 2, d2 / 2)
where d1
is the first degree of freedom, d2
is
the second degree of freedom, and I
is the regularized incomplete
beta function
fn inverse_cdf(&self, p: T) -> K
[src]
fn inverse_cdf(&self, p: T) -> K
[src]Due to issues with rounding and floating-point accuracy the default
implementation may be ill-behaved.
Specialized inverse cdfs should be used whenever possible.
Performs a binary search on the domain of cdf
to obtain an approximation
of F^-1(p) := inf { x | F(x) >= p }
. Needless to say, performance may
may be lacking. Read more
impl Debug for FisherSnedecor
[src]
impl Debug for FisherSnedecor
[src]impl Distribution<f64> for FisherSnedecor
[src]
impl Distribution<f64> for FisherSnedecor
[src]fn skewness(&self) -> Option<f64>
[src]
fn skewness(&self) -> Option<f64>
[src]Returns the skewness of the fisher-snedecor distribution
Panics
If freedom_2 <= 6.0
Remarks
Returns NaN
if freedom_1
or freedom_2
is INF
Formula
((2d1 + d2 - 2) * sqrt(8 * (d2 - 4))) / ((d2 - 6) * sqrt(d1 * (d1 + d2 - 2)))
where d1
is the first degree of freedom and d2
is
the second degree of freedom
impl Distribution<f64> for FisherSnedecor
[src]
impl Distribution<f64> for FisherSnedecor
[src]fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64
[src]
fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64
[src]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,
[src]
fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
R: Rng,
[src]Create an iterator that generates random values of T
, using rng
as
the source of randomness. Read more
impl Max<f64> for FisherSnedecor
[src]
impl Max<f64> for FisherSnedecor
[src]impl Min<f64> for FisherSnedecor
[src]
impl Min<f64> for FisherSnedecor
[src]impl Mode<Option<f64>> for FisherSnedecor
[src]
impl Mode<Option<f64>> for FisherSnedecor
[src]impl PartialEq<FisherSnedecor> for FisherSnedecor
[src]
impl PartialEq<FisherSnedecor> for FisherSnedecor
[src]fn eq(&self, other: &FisherSnedecor) -> bool
[src]
fn eq(&self, other: &FisherSnedecor) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &FisherSnedecor) -> bool
[src]
fn ne(&self, other: &FisherSnedecor) -> bool
[src]This method tests for !=
.
impl Copy for FisherSnedecor
[src]
impl StructuralPartialEq for FisherSnedecor
[src]
Auto Trait Implementations
impl RefUnwindSafe for FisherSnedecor
impl Send for FisherSnedecor
impl Sync for FisherSnedecor
impl Unpin for FisherSnedecor
impl UnwindSafe for FisherSnedecor
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,