Skip to main content

PoissonLikelihood

Struct PoissonLikelihood 

Source
pub struct PoissonLikelihood {
    pub function_name: String,
    pub description: String,
    pub formula: String,
}
Expand description

Likelihood for count data under a Poisson model.

Fields§

§function_name: String

Unique name identifying a likelihood function.

§description: String

Free-text description.

§formula: String

Mathematical formula.

Implementations§

Source§

impl PoissonLikelihood

Source

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

Computes the closed-form maximum-likelihood fit λ̂ = x̄ (the sample mean) of the Poisson rate.

The estimate is exact, so the returned MleFit reports converged as true and zero iterations; its AIC/BIC follow the shared information-criteria formulas with k = 1 parameter.

§Arguments
  • data — the observed counts; each entry must be a finite, non-negative integer, and the sample must contain at least one non-zero count.
§Returns

An MleFit whose single parameter is λ̂ and whose log_likelihood is ℓ(λ̂; data).

§Errors
§Examples
use stats_claw::likelihood::PoissonLikelihood;

let model = PoissonLikelihood::default();
let fit = model.fit(&[2.0, 3.0, 1.0, 5.0, 0.0, 4.0, 2.0, 3.0])?;
// The MLE of the Poisson rate is the sample mean, here 20 / 8 = 2.5.
assert!((fit.params()[0] - 2.5).abs() < 1e-12, "lambda_hat was {}", fit.params()[0]);

Trait Implementations§

Source§

impl Clone for PoissonLikelihood

Source§

fn clone(&self) -> PoissonLikelihood

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 PoissonLikelihood

Source§

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

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

impl Default for PoissonLikelihood

Source§

fn default() -> PoissonLikelihood

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

impl LogLikelihood for PoissonLikelihood

Source§

fn n_params(&self) -> usize

Returns the single free parameter count of the Poisson model, 1 (the rate λ).

Source§

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

Evaluates ℓ([λ]; data) = Σᵢ (xᵢ·ln λ − λ − ln Γ(xᵢ + 1)).

Returns f64::NEG_INFINITY when params[0] = λ ≤ 0 (or is NaN), and likewise when any observation is negative, non-integer, or non-finite — all of which lie outside the Poisson support.

§Arguments
  • params — the one-element rate vector [λ]; a shorter slice yields f64::NEG_INFINITY.
  • data — the observed counts.
§Returns

The total log-likelihood, or f64::NEG_INFINITY outside the valid domain.

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.