Enum InferenceCovarianceMode 

pub enum InferenceCovarianceMode {
    Conditional,
    SmoothingCorrected,
}

Which posterior covariance definition an uncertainty surface was built from.

This is the library’s ONE covariance-definition vocabulary, and it lives here — beside SmoothingCorrectionMethod, which names how the correction was produced — rather than in a predict-layer crate, so that every consumer of a fit can say which of the two matrices it read. A family that owns its own predict surface (the multinomial) sits BELOW gam-predict in the crate graph; when this enum lived up there, that family had no way to express the distinction and quietly published conditional-only bands while every other family defaulted to Self::SmoothingCorrected (gam#2612).

Variants

Conditional

Use conditional posterior covariance only: Var(beta | lambda_hat) ~= H_{rho_hat}^{-1}.

SmoothingCorrected

Require first-order smoothing-corrected covariance: Var(beta) ~= H_{rho_hat}^{-1} + J Var(rho_hat) J^T. Absence is an error; this mode never substitutes conditional covariance.

Implementations

impl InferenceCovarianceMode

pub const fn as_str(self) -> &'static str

Trait Implementations

impl Clone for InferenceCovarianceMode

fn clone(&self) -> InferenceCovarianceMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for InferenceCovarianceMode

impl Debug for InferenceCovarianceMode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InferenceCovarianceMode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for InferenceCovarianceMode

impl FromStr for InferenceCovarianceMode

fn from_str(raw: &str) -> Result<Self, Self::Err>

The one public vocabulary for the covariance-mode knob across every surface (gam predict --covariance-mode, Python covariance_mode). The CLI historically said “corrected” and the Python bindings said “smoothing” for the SAME mode; both spellings (plus the enum’s own canonical “smoothing-corrected”) are accepted here so the vocabulary cannot drift per frontend again. Unknown strings are a hard error so a typo never silently degrades to a default covariance.

type Err = String

The associated error which can be returned from parsing.

impl PartialEq for InferenceCovarianceMode

fn eq(&self, other: &InferenceCovarianceMode) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for InferenceCovarianceMode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InferenceCovarianceMode