Struct statrs::distribution::Erlang [−][src]
pub struct Erlang { /* fields omitted */ }
Expand description
Implements the Erlang distribution which is a special case of the Gamma distribution
Examples
use statrs::distribution::{Erlang, Continuous}; use statrs::statistics::Distribution; use statrs::prec; let n = Erlang::new(3, 1.0).unwrap(); assert_eq!(n.mean().unwrap(), 3.0); assert!(prec::almost_eq(n.pdf(2.0), 0.270670566473225383788, 1e-15));
Implementations
impl Erlang
[src]
impl Erlang
[src]pub fn new(shape: u64, rate: f64) -> Result<Erlang>
[src]
pub fn new(shape: u64, rate: f64) -> Result<Erlang>
[src]Constructs a new erlang distribution with a shape (k)
of shape
and a rate (λ) of rate
Errors
Returns an error if shape
or rate
are NaN
.
Also returns an error if shape == 0
or rate <= 0.0
Examples
use statrs::distribution::Erlang; let mut result = Erlang::new(3, 1.0); assert!(result.is_ok()); result = Erlang::new(0, 0.0); assert!(result.is_err());
Trait Implementations
impl Continuous<f64, f64> for Erlang
[src]
impl Continuous<f64, f64> for Erlang
[src]impl ContinuousCDF<f64, f64> for Erlang
[src]
impl ContinuousCDF<f64, f64> for Erlang
[src]fn cdf(&self, x: f64) -> f64
[src]
fn cdf(&self, x: f64) -> f64
[src]Calculates the cumulative distribution function for the erlang
distribution
at x
Formula
γ(k, λx) (k - 1)!
where k
is the shape, λ
is the rate, and γ
is the lower
incomplete gamma 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 Distribution<f64> for Erlang
[src]
impl Distribution<f64> for Erlang
[src]fn variance(&self) -> Option<f64>
[src]
fn variance(&self) -> Option<f64>
[src]Returns the variance of the erlang distribution
Formula
k / λ^2
where α
is the shape and λ
is the rate
fn entropy(&self) -> Option<f64>
[src]
fn entropy(&self) -> Option<f64>
[src]Returns the entropy of the erlang distribution
Formula
k - ln(λ) + ln(Γ(k)) + (1 - k) * ψ(k)
where k
is the shape, λ
is the rate, Γ
is the gamma function,
and ψ
is the digamma function
impl Distribution<f64> for Erlang
[src]
impl Distribution<f64> for Erlang
[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 Copy for Erlang
[src]
impl StructuralPartialEq for Erlang
[src]
Auto Trait Implementations
impl RefUnwindSafe for Erlang
impl Send for Erlang
impl Sync for Erlang
impl Unpin for Erlang
impl UnwindSafe for Erlang
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>,