Skip to main content

BinomialLikelihood

Struct BinomialLikelihood 

Source
pub struct BinomialLikelihood {
    pub number_of_trials: i64,
    pub function_name: String,
    pub description: String,
    pub formula: String,
}
Expand description

Likelihood for success counts under a binomial model.

Fields§

§number_of_trials: i64

Number of trials.

§function_name: String

Unique name identifying a likelihood function.

§description: String

Free-text description.

§formula: String

Mathematical formula.

Implementations§

Source§

impl BinomialLikelihood

Source

pub fn fit(&self, data: &[f64]) -> Result<MleFit>

Closed-form maximum-likelihood fit of the success probability p.

The binomial MLE is p̂ = (Σᵢ xᵢ) / (N · n_trials) — the pooled success rate across all N draws. Because the estimate is analytic, the returned MleFit reports converged() == true and iterations() == 0, with the AIC/BIC computed for k = 1 parameter over N observations.

§Arguments
  • data — the observed per-draw success counts; each must be an integer in [0, n_trials]. Must be non-empty.
§Returns

An MleFit whose single parameter is .

§Errors
  • Error::InsufficientData if data is empty.
  • Error::InvalidInput if this model’s number_of_trials is not a positive integer, or if any observation is negative, non-integral, or greater than number_of_trials.
  • Error::DegenerateInput if every observation is 0 or every observation is n_trials (so lands on the boundary {0, 1} and the log-likelihood is degenerate).
§Examples
use stats_claw::likelihood::BinomialLikelihood;

let model = BinomialLikelihood { number_of_trials: 10, ..Default::default() };
let fit = model.fit(&[3.0, 5.0, 2.0, 4.0, 6.0])?;
// p̂ = 20 / (5·10) = 0.4.
assert!((fit.params()[0] - 0.4).abs() < 1e-12, "p_hat was {}", fit.params()[0]);
assert!(fit.converged());

Trait Implementations§

Source§

impl Clone for BinomialLikelihood

Source§

fn clone(&self) -> BinomialLikelihood

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 Debug for BinomialLikelihood

Source§

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

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

impl Default for BinomialLikelihood

Source§

fn default() -> BinomialLikelihood

Returns the “default value” for a type. Read more
Source§

impl LogLikelihood for BinomialLikelihood

Source§

fn n_params(&self) -> usize

The binomial has a single free parameter, the success probability p.

Source§

fn log_likelihood(&self, params: &[f64], data: &[f64]) -> f64

Evaluates ℓ(p; data) for the success probability params[0].

Returns f64::NEG_INFINITY outside the valid domain: when number_of_trials is not positive, p ∉ (0, 1), or any observation is negative, non-integral, or exceeds number_of_trials.

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.