gam 0.3.121

Generalized penalized likelihood 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

//! Shared import/prelude surface for the `solver::pirls` concern modules.
//!
//! Every name here is re-exported `pub(crate)` so each concern module can pull
//! the whole set with a single `use super::*;` (glob imports are exempt from the
//! unused-import lint, so no module is forced to enumerate exactly what it
//! touches). This mirrors the flat namespace the module used to share before the
//! concern split, without the line-cut `include!` fragments.

pub(crate) use crate::estimate::EstimationError;

pub(crate) use crate::estimate::reml::FirthDenseOperator;

pub(crate) use crate::faer_ndarray::{
    FaerCholesky, FaerEigh, FaerLinalgError, FaerSymmetricFactor, array1_to_col_matmut, fast_ab,
    fast_av, fast_av_into,
};

pub(crate) use crate::linalg::sparse_exact::{factorize_sparse_spd, solve_sparse_spd};

pub(crate) use crate::linalg::utils::{StableSolver, boundary_hit_step_fraction};

pub(crate) use crate::matrix::{DesignMatrix, LinearOperator};

pub(crate) use crate::mixture_link::{
    InverseLinkJet as MixtureInverseLinkJet, inverse_link_has_fisher_weight_jet,
    logit_inverse_link_jet5,
};

pub(crate) use crate::solver::active_set;

pub(crate) use crate::types::{Coefficients, LinearPredictor, StandardLink};

pub(crate) use crate::types::{
    GlmLikelihoodSpec, InverseLink, LikelihoodSpec, LinkFunction, MixtureLinkState, ResponseFamily,
    SasLinkState, is_valid_tweedie_power,
};

pub(crate) use dyn_stack::{MemBuffer, MemStack};

pub(crate) use faer::sparse::SparseColMat;

pub(crate) use faer::sparse::linalg::matmul::{
    SparseMatMulInfo, sparse_sparse_matmul_numeric, sparse_sparse_matmul_numeric_scratch,
    sparse_sparse_matmul_symbolic,
};

pub(crate) use faer::sparse::{
    SparseColMatMut, SparseColMatRef, SparseRowMat, SymbolicSparseColMat, SymbolicSparseColMatRef,
};

pub(crate) use faer::{Accum, Par, Side, Unbind, get_global_parallelism};

pub(crate) use ndarray::{Array1, Array2, ArrayView1, ArrayView2, ArrayView3, ShapeBuilder, Zip};

pub(crate) use rayon::iter::{
    IndexedParallelIterator, IntoParallelRefMutIterator, ParallelIterator,
};

pub(crate) use statrs::function::gamma::{digamma, ln_gamma};

pub(crate) use faer::linalg::cholesky::llt::factor::LltParams;

pub(crate) use faer::{Auto, Spec};

pub(crate) use std::collections::BTreeSet;

pub(crate) use std::collections::HashMap;

pub(crate) use std::sync::{Arc, Mutex, OnceLock};

pub use crate::solver::active_set::{
    ACTIVE_SET_PRIMAL_FEASIBILITY_TOL, ConstraintKktDiagnostics, LinearInequalityConstraints,
};

pub(crate) use crate::linalg::utils::{array_is_finite, inf_norm, row_chunk_for_byte_budget};

// `log` is used as a path (`log::debug!`), so re-export the crate itself.
pub(crate) use log;

#[cfg(test)]
mod tests {
    /// Locks the `solver::pirls::prelude` module path (renamed from `imports`
    /// per #1137) and a representative re-exported symbol as an invariant.
    #[test]
    fn pirls_prelude_module_path_is_locked() {
        // Resolving these paths fails to compile if the module is renamed or
        // the key re-export is dropped.
        use crate::solver::pirls::prelude::DesignMatrix;
        assert!(core::any::type_name::<DesignMatrix>().contains("DesignMatrix"));
    }
}