Skip to main content

Module model_types

Module model_types 

Source
Expand description

crate::model_types → fit-result / penalty-spec carriers now in gam-solve, plus the finite-validation helper from gam-problem that gam-solve only re-exports crate-internally.

Structs§

ActiveLinearConstraintBlock
Active row block of the joint linear inequality constraint matrix at the converged inner iterate.
AdaptiveRegularizationOptions
CertifiedRung
The rung a CERTIFICATE was decided against, in owned form (#2530).
CurvatureFloorClearance
Analytic optimality certificate at the returned optimum (#934).
Dispersion
A validated response-level dispersion phi.
DisplayCoefficientUncertainty
A definition-consistent coefficient-uncertainty view (#2296): standard errors and (optional) covariance from the SAME definition, tagged with that definition. Produced by UnifiedFitResult::display_coefficient_uncertainty.
FitArtifacts
Post-fit artifacts needed by downstream diagnostics/inference without re-running PIRLS.
FitGeometry
Coefficient geometry retained at convergence for inference and post-fit diagnostics.
FitInference
FitOptions
FittedBlock
Inference quantities for one coefficient block.
OuterCriterionCertificate
ProjectedKktResidual
KKT residual r = grad_beta L_pen(beta_hat) at the converged inner iterate, tagged with the exact represented subspace.
RailCoordinate
One outer smoothing coordinate certified stationary-at-asymptote: it has no interior optimum (its gradient never clears the fixed bound), but the fitted model has provably reached its rail limit to within tolerance along it (#2348 Inc 1 / #2299 layer 3, #2337 Thm 2.1). The certified facts are the per-coordinate outputs of crate::rho_optimizer::asymptote_certificate::assess_coordinate.
RailedCoordinateFact
One railed coordinate together with the interval and margin it was judged against (#2530).
UnifiedFitResult
Unified fit result for all model types (standard GAM, GAMLSS, survival).
UnifiedFitResultParts
WorkingGeometry
Owned diagonal working-set evidence at convergence.

Enums§

BlockRole
Role of a coefficient block within a multi-parameter model.
CoefficientCovarianceDefinition
Exact coefficient-covariance definition (#2296).
CoefficientPriorMean
Programmatic prior mean for a coefficient penalty block.
CovarianceDeclined
Why a fit that could have published a coefficient covariance deliberately did not (gam#2718, gam#2484).
CurvatureEvidence
What curvature evidence a certificate actually has (#2561).
EstimationError
A comprehensive error type for the model estimation process.
ExecutionPath
Truthful execution-path classifier for a fit’s hot inner solve (issue #1017).
FittedLinkState
InferenceCovarianceMode
Which posterior covariance definition an uncertainty surface was built from.
KktResidualSubspace
Subspace represented by a stored KKT residual.
OuterStationarityCertificate
The stationarity equation that certified an outer optimum.
PenaltySpec
A penalty specification for the public estimate API.
RailTailEvidence
What established a rail coordinate’s tail law, and the standard it cleared (#2348 Inc 5 build-out).
SmoothingCorrectionMethod
Serialized provenance of a retained smoothing-uncertainty correction.

Constants§

NO_CRITERION_AT_EXACT_FIT
The one explanation every ranking surface gives for an absent criterion.

Functions§

criterion_display
Render a possibly-absent criterion for human output.
ensure_finite_scalar
Public wrapper returning String errors for use outside the estimation module.
ensure_finite_scalar_estimation
is_zero_dispersion_boundary
The exact-fit Gaussian boundary, from the three quantities that define it.
saved_latent_cloglog_state_from_fit
saved_mixture_state_from_fit
saved_sas_state_from_fit
validate_all_finite
Public wrapper returning String errors for use outside the estimation module.
validate_dense_hessian_export
Validate the structural integrity of an exported penalized Hessian.
validate_explicit_dense_hessian_for_whitening
Validate that a saved penalized Hessian is an explicit dense precision matrix suitable for HMC/NUTS whitening.