Struct ParameterBlock 

pub struct ParameterBlock<P, L, X, Penalty> { /* private fields */ }

Typed coefficient block for a single distribution parameter.

P specifies the parameter role, L specifies the link function, X holds the predictor block, and Penalty adds regularization. The block stores its coefficient range within the common beta vector; use Self::range and Self::len to inspect that layout.

Implementations

impl<P, L, X, Penalty> ParameterBlock<P, L, X, Penalty>

where X: PredictorBlock,

pub fn new( x: X, penalty: Penalty, offset: usize, ) -> ParameterBlock<P, L, X, Penalty>

Creates a block, taking len from x.nparams().

pub fn from_predictor( x: X, penalty: Penalty, offset: usize, ) -> ParameterBlock<P, L, X, Penalty>

Creates a block from a generic predictor.

This is a synonym for Self::new, kept for code where the explicit predictor word makes the call more readable.

impl<P, L, X, Penalty> ParameterBlock<P, L, LinearPredictorBlock<X>, Penalty>

where X: DesignMatrix,

pub fn linear( x: X, penalty: Penalty, offset: usize, ) -> ParameterBlock<P, L, LinearPredictorBlock<X>, Penalty>

Creates a linear block from a design matrix.

impl<P, L, X, Penalty> ParameterBlock<P, L, X, Penalty>

pub const fn with_offset( self, offset: usize, ) -> ParameterBlock<P, L, X, Penalty>

Returns a copy of the block with a new offset.

pub const fn x(&self) -> &X

Predictor block.

pub const fn penalty(&self) -> &Penalty

Penalty applied to the block’s coefficients.

pub const fn range(&self) -> Range<usize>

Coefficient range of the block in the common beta vector.

Panics

Panics if offset + len overflows. Use Self::try_range when the offset may come from unchecked external input.

pub const fn end(&self) -> usize

Index immediately after the last coefficient of the block.

Panics

Panics if offset + len overflows. Use Self::try_range for recoverable validation.

pub const fn len(&self) -> usize

Number of coefficients in the block.

pub const fn is_empty(&self) -> bool

true if the block contains no coefficients.

impl<P, L, X, Penalty> ParameterBlock<P, L, X, Penalty>

where P: ParameterName,

pub fn try_range(&self) -> Result<Range<usize>, ModelError>

Validates and returns the block’s coefficient range.

Errors

Returns ModelError::BlockRangeOverflow if offset + len does not fit in usize.

Trait Implementations

impl<P, L, X, Penalty> Clone for ParameterBlock<P, L, X, Penalty>

where P: Clone, L: Clone, X: Clone, Penalty: Clone,

fn clone(&self) -> ParameterBlock<P, L, X, Penalty>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P, L, X, Penalty> Debug for ParameterBlock<P, L, X, Penalty>

where P: Debug, L: Debug, X: Debug, Penalty: Debug,

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

Formats the value using the given formatter.

impl<P, L, X, Penalty> Eq for ParameterBlock<P, L, X, Penalty>

where P: Eq, L: Eq, X: Eq, Penalty: Eq,

impl<P, L, X, Penalty> PartialEq for ParameterBlock<P, L, X, Penalty>

where P: PartialEq, L: PartialEq, X: PartialEq, Penalty: PartialEq,

fn eq(&self, other: &ParameterBlock<P, L, X, Penalty>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P, L, X, Penalty> StructuralPartialEq for ParameterBlock<P, L, X, Penalty>

where P: PartialEq, L: PartialEq, X: PartialEq, Penalty: PartialEq,