Struct BasisIdx 

pub struct BasisIdx(/* private fields */);

Index into a single smooth term’s set of basis functions — i.e. the k in “the k-th basis function B_k(x) of this term”.

Distinct from:

• SmoothTermIdx — selects which smooth term in the spec.
• PenaltyIdx — selects which ρ/λ entry / canonical penalty.
• A design-matrix column index — which lives in the combined layout after intercept/parametric blocks and per-term offsets are applied; a BasisIdx is term-local, a column index is model-global.

Keeping this as its own #[repr(transparent)] newtype makes the historically-easy confusion “indexed a global column slice with a term-local basis ordinal” (or vice versa) a compile error.

Implementations

impl BasisIdx

pub const fn new(idx: usize) -> Self

pub const fn get(self) -> usize

Trait Implementations

impl Clone for BasisIdx

fn clone(&self) -> BasisIdx

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BasisIdx

impl Debug for BasisIdx

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BasisIdx

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BasisIdx

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

Formats the value using the given formatter.

impl Eq for BasisIdx

impl Hash for BasisIdx

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BasisIdx

fn cmp(&self, other: &BasisIdx) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BasisIdx

fn eq(&self, other: &BasisIdx) -> 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 PartialOrd for BasisIdx

fn partial_cmp(&self, other: &BasisIdx) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for BasisIdx

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 BasisIdx