Skip to main content

Beta

Struct Beta 

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

A continuous distribution on the interval (0, 1), commonly used for modeling probabilities and proportions.

Conjugate prior for Bernoulli/Binomial distributions.

Mathematical Properties:

  • Support: (0, 1); the closed endpoints 0 and 1 are handled as limits
  • PDF: f(x) = (x^(α-1) × (1-x)^(β-1)) / B(α,β)
  • Mean: α / (α + β)
  • Variance: (αβ) / ((α+β)²(α+β+1))

Boundary semantics (matching scipy.stats.beta.logpdf): at x = 0, log_prob is -∞ when α > 1 (density → 0), ln(β) when α == 1, and +∞ when α < 1 (density diverges, e.g. the Jeffreys prior Beta(0.5, 0.5)). The endpoint x = 1 is symmetric in β.

Example:


// Uniform on [0,1]
let uniform = sample(addr!("p"), Beta::new(1.0, 1.0).unwrap());

// Prior for success probability
let prob_prior = sample(addr!("success_rate"), Beta::new(2.0, 5.0).unwrap());

// Conjugate prior-likelihood pair
let model = sample(addr!("p"), Beta::new(3.0, 7.0).unwrap())
    .bind(|p| observe(addr!("trial"), Bernoulli::new(p).unwrap(), true));

// Skewed towards 0 (beta > alpha)
let skewed = sample(addr!("proportion"), Beta::new(2.0, 8.0).unwrap());

Implementations§

Source§

impl Beta

Source

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

Create a new Beta distribution with validated parameters.

Source

pub fn uniform_prior() -> Self

Create the uniform-prior Beta distribution Beta(1, 1).

FG-29: infallible constructor for the statically-valid α = β = 1 case, which is exactly the uniform distribution on (0, 1) and the standard uninformative conjugate prior for a Bernoulli/Binomial probability; avoids new(1.0, 1.0).unwrap().

let prior = Beta::uniform_prior();
assert_eq!(prior.alpha(), 1.0);
assert_eq!(prior.beta(), 1.0);
Source

pub fn alpha(&self) -> f64

Get the alpha parameter.

Source

pub fn beta(&self) -> f64

Get the beta parameter.

Trait Implementations§

Source§

impl Clone for Beta

Source§

fn clone(&self) -> Beta

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Beta

Source§

impl Debug for Beta

Source§

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

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

impl Distribution<f64> for Beta

Source§

fn sample(&self, rng: &mut dyn RngCore) -> f64

Generate a random sample (with its natural type), T, from the distribution, using the provided random number generator, rng. Read more
Source§

fn log_prob(&self, x: &f64) -> LogF64

Compute the log-probability density (continuous) or mass (discrete) of a value, x, from the distribution. Read more
Source§

fn clone_box(&self) -> Box<dyn Distribution<f64>>

Clone the distribution into a boxed trait object, Box<dyn Distribution<T>>. Read more
Source§

impl Validate for Beta

Auto Trait Implementations§

§

impl Freeze for Beta

§

impl RefUnwindSafe for Beta

§

impl Send for Beta

§

impl Sync for Beta

§

impl Unpin for Beta

§

impl UnsafeUnpin for Beta

§

impl UnwindSafe for Beta

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