digifi::statistics::continuous_distributions

Struct GammaDistribution

pub struct GammaDistribution { /* private fields */ }

Expand description

§Description

Methods and properties of Gamma distribution.

§Links

Wikipedia: https://en.wikipedia.org/wiki/Gamma_distribution
Original Source: N/A

§Examples

use ndarray::{Array1, arr1};
use digifi::utilities::TEST_ACCURACY;
use digifi::statistics::{ProbabilityDistribution, GammaDistribution};

let dist: GammaDistribution = GammaDistribution::new(0.5, 2.0).unwrap();
let x: Array1<f64> = arr1(&[0.6]);

// PDF test
let pdf_v: f64 = dist.pdf(&x).unwrap()[0];
assert!((pdf_v - 0.38154528938409304).abs() < TEST_ACCURACY);

// CDF test
let cdf_v: f64 = dist.cdf(&x).unwrap()[0];
assert!((cdf_v - 0.5614219739190003).abs() < TEST_ACCURACY);

// Inverse CDF test
let icdf_v: f64 = dist.inverse_cdf(&arr1(&[0.5614219739190003])).unwrap()[0];
assert!((icdf_v - x[0]).abs() < TEST_ACCURACY);

Implementations§

impl GammaDistribution

pub fn new(k: f64, theta: f64) -> Result<Self, DigiFiError>

§Description

Creates a new GammaDistribution instance.

§Input

k: Shape parameter, which controls the shape of the distribution
theta: Scale parameter, which controls the spread of the distribution

Trait Implementations§

impl Debug for GammaDistribution

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

Formats the value using the given formatter. Read more

impl ProbabilityDistribution for GammaDistribution

fn pdf(&self, x: &Array1<f64>) -> Result<Array1<f64>, DigiFiError>

§Description

Calculates the Probability Density Function (PDF) for a Gamma distribution.

§Input

x: Values at which to calculate the PDF

§Output

PDF values at the given x

fn cdf(&self, x: &Array1<f64>) -> Result<Array1<f64>, DigiFiError>

§Description

Computes the Cumulative Distribution Function (CDF) for a Gamma distribution.

§Input

x: Values at which to calculate the CDF

§Output

CDF values at the given x

fn inverse_cdf(&self, p: &Array1<f64>) -> Result<Array1<f64>, DigiFiError>

§Description

Computes the Inverse Cumulative Distribution Function (Inverse CDF) for a Gamma distribution.

§Input

p: Probability values for which to calculate the inverse CDF

§Output

Inverse CDF values for the given probabilities

fn mgf(&self, t: &Array1<usize>) -> Array1<f64>

§Description

Calculates the Moment Generating Function (MGF) for a Gamma distribution.

§Input

t: Input values for the MGF

§Output

MGF values at the given t

fn mean(&self) -> f64

Description Read more

fn median(&self) -> Vec<f64>

Description Read more

fn mode(&self) -> Vec<f64>

Description Read more

fn variance(&self) -> f64

Description Read more

fn skewness(&self) -> f64

Description Read more

fn excess_kurtosis(&self) -> f64

Description Read more

fn entropy(&self) -> Result<f64, DigiFiError>

Description Read more

Auto Trait Implementations§

impl Freeze for GammaDistribution

impl RefUnwindSafe for GammaDistribution

impl Send for GammaDistribution

impl Sync for GammaDistribution

impl Unpin for GammaDistribution

impl UnwindSafe for GammaDistribution

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> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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.