Skip to main content

ExponentialLikelihood

Struct ExponentialLikelihood 

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

Likelihood for waiting-time data under an exponential model.

Fields§

§function_name: String

Unique name identifying a likelihood function.

§description: String

Free-text description.

§formula: String

Mathematical formula.

Implementations§

Source§

impl ExponentialLikelihood

Source

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

Fits this exponential model to data by its closed-form maximum-likelihood estimate λ̂ = n / Σxᵢ.

The rate MLE is analytic, so the returned MleFit reports converged = true and zero iterations; its log_likelihood is ℓ(λ̂; data) and the AIC/BIC follow from k = 1 parameter and n = data.len().

§Arguments
  • data — the observed sample; every value must be ≥ 0 (the exponential support) and the sample must be non-empty with a strictly positive sum.
§Returns

An MleFit whose single parameter is the rate estimate λ̂.

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

let fit = ExponentialLikelihood::default().fit(&[1.0, 2.0, 3.0])?;
// λ̂ = 3 / 6 = 0.5.
assert!((fit.params()[0] - 0.5).abs() < 1e-12, "lambda_hat was {}", fit.params()[0]);
assert!(fit.converged());

Trait Implementations§

Source§

impl Clone for ExponentialLikelihood

Source§

fn clone(&self) -> ExponentialLikelihood

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 ExponentialLikelihood

Source§

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

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

impl Default for ExponentialLikelihood

Source§

fn default() -> ExponentialLikelihood

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

impl LogLikelihood for ExponentialLikelihood

Source§

fn n_params(&self) -> usize

Returns 1: the exponential rate model has the single parameter λ.

§Examples
use stats_claw::likelihood::ExponentialLikelihood;
use stats_claw::likelihood::LogLikelihood;

assert_eq!(ExponentialLikelihood::default().n_params(), 1);
Source§

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

Evaluates the total exponential log-likelihood ℓ(λ; data) = n·ln λ − λ·Σxᵢ.

§Arguments
  • params — the one-element rate vector [λ]; only params[0] is read.
  • data — the observed sample.
§Returns

The scalar log-likelihood, or f64::NEG_INFINITY when λ ≤ 0, or any observation is negative or non-finite — all lie outside the model’s valid domain. Per the LogLikelihood contract a non-finite observation (NaN or ±∞) yields −∞ rather than propagating a NaN/incidental −∞.

§Examples
use stats_claw::likelihood::ExponentialLikelihood;
use stats_claw::likelihood::LogLikelihood;

let model = ExponentialLikelihood::default();
// ℓ(1; [1, 2]) = 2·ln 1 − 1·3 = −3.
assert!((model.log_likelihood(&[1.0], &[1.0, 2.0]) + 3.0).abs() < 1e-12);
// A non-positive rate is outside the domain.
assert_eq!(model.log_likelihood(&[0.0], &[1.0]), f64::NEG_INFINITY);

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.