Struct JointPenaltySpec 

pub struct JointPenaltySpec {
    pub label: Option<String>,
    pub matrix: Array2<f64>,
    pub initial_log_lambda: f64,
    pub nullspace_dim: usize,
}

A penalty whose support spans the entire compiled parameter vector.

Unlike [crate::families::custom_family::PenaltyMatrix], this carries a single dense total_compiled × total_compiled quadratic form — the shape produced by T^T S_j T pullback after the V+M / SMGS-exact compile. The nullspace_dim is the structural dimension of ker(S) as reported by the construction site (rank-revealing on the pulled-back operator, not the pre-pullback S_j), so the REML pseudo-logdet can avoid numerical rank thresholds.

Fields

label: Option<String>

Optional user-visible precision label. Joint penalties that share a label share one smoothing parameter (same convention as [crate::families::custom_family::PenaltyMatrix::Labeled]).

matrix: Array2<f64>

Dense symmetric PSD matrix of shape (total_compiled, total_compiled).

initial_log_lambda: f64

Initial value of log λ for this penalty.

nullspace_dim: usize

Structural nullspace dimension of matrix (i.e. total_compiled - rank).

Implementations

impl JointPenaltySpec

pub fn dim(&self) -> usize

Total compiled parameter count this penalty acts on.

pub fn trace(&self) -> f64

Trace of the penalty matrix (Σ_i S[i,i]).

pub fn pseudo_rank(&self) -> usize

Structural pseudo-rank, derived from the declared nullspace_dim. This is the rank used by the REML pseudo-logdet under the no-numerical-thresholds policy in the surrounding code.

pub fn quadratic_form(&self, beta: ArrayView1<'_, f64>) -> f64

Quadratic form βᵀ S β. Mirrors [crate::families::custom_family::PenaltyMatrix::quadratic_form] for the full-width case.

pub fn validate(&self) -> Result<(), JointPenaltyError>

Validate shape, finiteness, symmetry, and nullspace bookkeeping.

Trait Implementations

impl Clone for JointPenaltySpec

fn clone(&self) -> JointPenaltySpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JointPenaltySpec

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

Formats the value using the given formatter.