Skip to main content

GammaDistribution

Struct GammaDistribution 

Source
pub struct GammaDistribution { /* private fields */ }
Expand description

Gamma distribution with shape α and rate β (or equivalently scale θ = 1/β).

Uses the (shape, rate) parametrization: X ~ Gamma(α, β).

§PDF

f(x) = β^α / Γ(α) · x^(α−1) · exp(−βx) for x > 0

§Examples

use u_numflow::distributions::GammaDistribution;

let g = GammaDistribution::new(2.0, 1.0).unwrap();
assert!((g.mean() - 2.0).abs() < 1e-10);
assert!((g.variance() - 2.0).abs() < 1e-10);

§Reference

Johnson, N.L., Kotz, S. & Balakrishnan, N. (1994). Continuous Univariate Distributions, Vol. 1, 2nd ed. Wiley.

Implementations§

Source§

impl GammaDistribution

Source

pub fn new(shape: f64, rate: f64) -> Result<Self, DistributionError>

Creates a Gamma(α, β) distribution with shape α and rate β.

Returns an error if α ≤ 0, β ≤ 0, or either is not finite.

Source

pub fn from_shape_scale( shape: f64, scale: f64, ) -> Result<Self, DistributionError>

Creates a Gamma distribution from shape and scale θ = 1/β.

Source

pub fn shape(&self) -> f64

Shape parameter α.

Source

pub fn rate(&self) -> f64

Rate parameter β.

Source

pub fn scale(&self) -> f64

Scale parameter θ = 1/β.

Source

pub fn mean(&self) -> f64

Mean = α/β.

Source

pub fn variance(&self) -> f64

Variance = α/β².

Source

pub fn mode(&self) -> f64

Mode = (α−1)/β for α ≥ 1, 0 for α < 1.

Source

pub fn pdf(&self, x: f64) -> f64

PDF: f(x) = β^α / Γ(α) · x^(α−1) · exp(−βx) for x > 0.

Source

pub fn cdf(&self, x: f64) -> f64

CDF: F(x) = γ(α, βx) / Γ(α) = regularized lower incomplete gamma.

Uses series expansion for small x or continued fraction for large x.

Source

pub fn quantile(&self, p: f64) -> Option<f64>

Quantile (inverse CDF) via Newton-Raphson iteration.

Returns None if p is not in [0, 1].

Trait Implementations§

Source§

impl Clone for GammaDistribution

Source§

fn clone(&self) -> GammaDistribution

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GammaDistribution

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for GammaDistribution

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V