Struct GlmmFit 

pub struct GlmmFit { /* private fields */ }

A fitted random-intercept generalized linear mixed model (GLMM),

g(E[yᵢⱼ | bⱼ]) = xᵢⱼᵀβ + bⱼ, bⱼ ~ N(0, σ_b²),

for a non-Gaussian conditional GlmmFamily (Poisson counts or Bernoulli outcomes) — the generalized counterpart to LinearMixedModel. The intractable integral over the random effects is handled by the Laplace approximation: an inner Newton loop finds each group’s conditional mode, and an outer Nelder–Mead search maximizes the resulting approximate marginal likelihood over the fixed effects β and the random-intercept standard deviation σ_b.

Fixed-effect standard errors come from the numerical observed information of the Laplace log-likelihood. The random-intercept variance is reported as σ_b; as it shrinks toward zero the model approaches the corresponding plain GLM.

Implementations

impl GlmmFit

pub fn new( x: Array2<f64>, y: Array1<f64>, groups: &[usize], family: GlmmFamily, ) -> Result<Self>

Fit a random-intercept GLMM of y on fixed-effect design X with group labels groups, under family, by Laplace-approximate maximum likelihood.

X carries the fixed effects including an intercept.

Errors

• RegressionError::EmptyInput / RegressionError::ShapeMismatch.
• RegressionError::InvalidResponse for out-of-support responses or fewer than two groups.
• RegressionError::NotConverged if the optimizer fails to find a finite optimum.

pub fn family(&self) -> GlmmFamily

The conditional family.

pub fn n_observations(&self) -> usize

Number of observations.

pub fn n_parameters(&self) -> usize

Number of fixed-effect coefficients.

pub fn n_groups(&self) -> usize

Number of groups.

pub fn coefficients(&self) -> ArrayView1<'_, f64>

Fixed-effect coefficients β̂ (link scale).

pub fn sigma_b(&self) -> f64

Random-intercept standard deviation σ̂_b.

pub fn group_variance(&self) -> f64

Random-intercept variance σ̂_b².

pub fn covariance(&self) -> ArrayView2<'_, f64>

Fixed-effect covariance (inverse observed information of the Laplace likelihood).

pub fn coefficient_standard_errors(&self) -> Array1<f64>

Fixed-effect standard errors.

pub fn z_values(&self) -> Array1<f64>

Wald z-statistics βⱼ / seⱼ.

pub fn p_values(&self) -> Array1<f64>

Two-sided Wald p-values from the standard normal.

pub fn random_effects(&self) -> ArrayView1<'_, f64>

Predicted (conditional-mode) random intercepts b̂_j, in densified group order.

pub fn log_likelihood(&self) -> f64

The Laplace-approximate log-likelihood at the estimate.

pub fn aic(&self) -> f64

AIC, −2ℓ + 2(p + 1) (fixed effects plus the variance component).

Trait Implementations

impl Clone for GlmmFit

fn clone(&self) -> GlmmFit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlmmFit

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

Formats the value using the given formatter.