Struct statrs::distribution::Gamma [−][src]
pub struct Gamma { /* fields omitted */ }
Expand description
Implementations
Constructs a new gamma distribution with a shape (α)
of shape
and a rate (β) of rate
Errors
Returns an error if shape
is ‘NaN’ or inf or rate
is NaN
or inf.
Also returns an error if shape <= 0.0
or rate <= 0.0
Examples
use statrs::distribution::Gamma; let mut result = Gamma::new(3.0, 1.0); assert!(result.is_ok()); result = Gamma::new(0.0, 0.0); assert!(result.is_err());
Returns the shape (α) of the gamma distribution
Examples
use statrs::distribution::Gamma; let n = Gamma::new(3.0, 1.0).unwrap(); assert_eq!(n.shape(), 3.0);
Trait Implementations
Calculates the cumulative distribution function for the gamma
distribution
at x
Formula
(1 / Γ(α)) * γ(α, β * x)
where α
is the shape, β
is the rate, Γ
is the gamma function,
and γ
is the lower incomplete gamma function
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
Generate a random value of T
, using rng
as the source of randomness.
Create an iterator that generates random values of T
, using rng
as
the source of randomness. Read more
Auto Trait Implementations
impl RefUnwindSafe for Gamma
impl UnwindSafe for Gamma
Blanket Implementations
Mutably borrows from an owned value. Read more
type Output = T
type Output = T
Should always be Self
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.
pub fn vzip(self) -> V