Skip to main content

BetaDistribution

Struct BetaDistribution 

Source
pub struct BetaDistribution {
    pub alpha: f64,
    pub beta: f64,
}
Expand description

Beta distribution on [0, 1].

§Mathematical Definition

  • PDF: f(x) = x^(α−1) (1−x)^(β−1) / B(α, β)
  • CDF: F(x) = I_x(α, β) (regularized incomplete beta)
  • Mean: α / (α + β)
  • Variance: αβ / ((α+β)²(α+β+1))

§Examples

use u_numflow::distributions::BetaDistribution;

let beta = BetaDistribution::new(2.0, 5.0).unwrap();
assert!((beta.mean() - 2.0 / 7.0).abs() < 1e-10);
assert!(beta.pdf(0.3) > 0.0);
assert!((beta.cdf(0.0)).abs() < 1e-10);
assert!((beta.cdf(1.0) - 1.0).abs() < 1e-10);

§References

Johnson, N. L., Kotz, S., & Balakrishnan, N. (1995). Continuous Univariate Distributions, Vol. 2, Chapter 25.

Fields§

§alpha: f64

Shape parameter α > 0.

§beta: f64

Shape parameter β > 0.

Implementations§

Source§

impl BetaDistribution

Source

pub fn new(alpha: f64, beta: f64) -> Result<Self, DistributionError>

Creates a new Beta distribution with shape parameters α and β.

§Errors

Returns DistributionError if α ≤ 0 or β ≤ 0.

Source

pub fn mean(&self) -> f64

Returns the mean: α / (α + β).

Source

pub fn variance(&self) -> f64

Returns the variance: αβ / ((α+β)²(α+β+1)).

Source

pub fn mode(&self) -> Option<f64>

Returns the mode.

Defined when α > 1 and β > 1: mode = (α−1)/(α+β−2). Returns None for other parameter combinations (bimodal or boundary modes).

Source

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

Evaluates the PDF at x.

Source

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

Evaluates the CDF at x: F(x) = I_x(α, β).

Source

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

Evaluates the quantile (inverse CDF) at probability p ∈ [0, 1].

Uses Newton-Raphson iteration with an initial approximation from the normal approximation to the beta distribution.

Trait Implementations§

Source§

impl Clone for BetaDistribution

Source§

fn clone(&self) -> BetaDistribution

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 BetaDistribution

Source§

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

Formats the value using the given formatter. Read more

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