glmm 0.1.0

Standalone f64 GLMM fit kernels (OLS, GLM, LMM, GLMM) in pure Rust on faer — the parity-pinned numerics from the MCPower engine.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! The crate's error surface. `ParseError`'s six variants and their Display
//! strings are a fixed contract — the parse test suite matches error
//! substrings against them, so both change together with `parse.rs`; `Error`
//! wraps it and adds the materialize-stage (data-dependent) failures. No
//! `thiserror` dep — Display is hand-written so the crate's only third-party
//! dependency stays `regex`.

use std::fmt;

/// Parse-stage (data-free) failures. Variants and Display strings are a fixed
/// contract (change together with `parse.rs`, which produces them).
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ParseError {
    /// The formula (or its RHS) is empty.
    EmptyFormula,
    /// A token on the RHS is not a valid identifier.
    Syntax {
        /// 0-based position of the offending token in the formula string.
        pos: usize,
        /// Description of what's wrong with the token.
        msg: String,
    },
    /// A `-` term removal outside parentheses (unsupported).
    TermRemovalUnsupported,
    /// The same grouping factor appears in two random-effect terms.
    DuplicateGroupingVar {
        /// The grouping factor name that appears more than once.
        name: String,
    },
    /// A slope term `(1+|g)` with no slope variables.
    EmptySlopeTerm {
        /// The grouping factor of the empty slope term.
        group: String,
    },
    /// Intercept suppression `(0+…|g)` / `(-1+…|g)` in a random-effect term.
    RandomInterceptSuppressionUnsupported,
}

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ParseError::EmptyFormula => write!(f, "formula is empty"),
            ParseError::Syntax { pos, msg } => {
                write!(f, "formula syntax error at position {pos}: {msg}")
            }
            ParseError::TermRemovalUnsupported => {
                write!(f, "term removal with '-' is not supported")
            }
            ParseError::DuplicateGroupingVar { name } => {
                write!(f, "duplicate grouping variable: {name}")
            }
            ParseError::EmptySlopeTerm { group } => {
                write!(f, "empty slope term for group {group}")
            }
            ParseError::RandomInterceptSuppressionUnsupported => write!(
                f,
                "a random slope requires a random intercept in this engine version; \
                 intercept suppression ('0 +' / '-1 +') in a random-effects term is \
                 not supported — write '(x | g)' or '(1 + x | g)'"
            ),
        }
    }
}

/// Everything `parse` or `materialize`/`lower` can reject.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Error {
    /// A data-free parse failure (see [`ParseError`]).
    Parse(ParseError),
    /// A name referenced by the formula is not a column of the data table.
    UnknownColumn(String),
    /// The response column exists but is not numeric.
    ResponseNotNumeric(String),
    /// A column referenced as numeric/factor has the wrong kind for its use.
    WrongColumnKind {
        /// The column name whose kind doesn't match its use.
        name: String,
        /// The kind the column was expected to be (`"numeric"` or `"factor"`).
        expected: &'static str,
    },
    /// A random-slope variable is not present as a (numeric) fixed term, so it
    /// has no `ColumnId` in the design. A future version may allow
    /// random-slope variables with no corresponding fixed-effect term.
    SlopeVarNotInDesign(String),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::Parse(e) => write!(f, "{e}"),
            Error::UnknownColumn(name) => write!(f, "unknown column: {name}"),
            Error::ResponseNotNumeric(name) => {
                write!(f, "response column '{name}' is not numeric")
            }
            Error::WrongColumnKind { name, expected } => {
                write!(f, "column '{name}' is not {expected}")
            }
            Error::SlopeVarNotInDesign(name) => write!(
                f,
                "random-slope variable '{name}' is not a numeric fixed term in the design"
            ),
        }
    }
}

impl std::error::Error for Error {}
impl std::error::Error for ParseError {}

impl From<ParseError> for Error {
    fn from(e: ParseError) -> Self {
        Error::Parse(e)
    }
}