Enum PenaltySpec 

pub enum PenaltySpec {
    Block {
        local: ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>,
        col_range: Range<usize>,
        prior_mean: CoefficientPriorMean,
        structure_hint: Option<PenaltyStructureHint>,
        op: Option<Arc<dyn PenaltyOp>>,
    },
    Dense(ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>),
    DenseWithMean {
        matrix: ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>,
        prior_mean: CoefficientPriorMean,
    },
}

A penalty specification for the public estimate API.

Block stores only the active sub-block and its column range, avoiding the O(p^2) cost of embedding into a full penalty matrix. Dense stores a full p x p penalty matrix for callers that already have one.

Variants

Block

Block-local penalty: local is block_dim x block_dim, applied to columns col_range of the coefficient vector.

Fields

local: ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>

col_range: Range<usize>

prior_mean: CoefficientPriorMean

structure_hint: Option<PenaltyStructureHint>

Optional structural hint for fast-path spectral decomposition.

op: Option<Arc<dyn PenaltyOp>>

Optional operator-form handle bit-equivalent to local.

Dense(ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>)

Full dense penalty matrix (p x p).

DenseWithMean

Full dense penalty matrix with a programmatic prior mean in the same global coefficient basis.

Fields

matrix: ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>

prior_mean: CoefficientPriorMean

Implementations

impl PenaltySpec

pub fn col_range(&self, p: usize) -> Range<usize>

The column range this penalty covers. For Dense, this is 0..p where p = m.ncols().

pub fn op(&self) -> Option<&Arc<dyn PenaltyOp>>

Op-form handle when present (only for Block; Dense always returns None).

pub fn from_blockwise(bp: BlockwisePenalty) -> PenaltySpec

Convert from a BlockwisePenalty, preserving the structure hint and op.

pub fn from_blockwise_ref(bp: &BlockwisePenalty) -> PenaltySpec

pub fn to_dense(&self) -> ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>

Materialize the full p x p dense penalty matrix. For Dense, this is a clone. For Block, this embeds local into a zero matrix at the given col_range.

pub fn to_global( &self, p_total: usize, ) -> ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>

Materialize the full p_total x p_total dense penalty matrix. For Dense, this is a clone (asserts that it matches p_total). For Block, this embeds local into a p_total x p_total zero matrix.

Trait Implementations

impl Clone for PenaltySpec

fn clone(&self) -> PenaltySpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PenaltySpec

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

Formats the value using the given formatter.