Struct SmoothTermIdx 

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

Index into TermCollectionSpec::smooth_terms (and the parallel TermCollectionDesign::smooth.terms slice produced from it).

This is not a penalty/ρ index, not a column index, and not a coefficient-offset index. Keeping it behind a #[repr(transparent)] newtype makes those confusables a compile error: a SmoothTermIdx cannot be silently used to index rho, beta, or a design column.

Implementations

impl SmoothTermIdx

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

pub const fn placeholder() -> Self

Sentinel used by transient builders that must allocate a coord config before the smooth term it references has been positioned in the spec. Every code path that constructs a sentinel must overwrite it before the value escapes the builder.

pub const fn get(self) -> usize

pub const fn is_placeholder(self) -> bool

Trait Implementations

impl Clone for SmoothTermIdx

fn clone(&self) -> SmoothTermIdx

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SmoothTermIdx

impl Debug for SmoothTermIdx

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SmoothTermIdx

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SmoothTermIdx

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

Formats the value using the given formatter.

impl Eq for SmoothTermIdx

impl Hash for SmoothTermIdx

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 SmoothTermIdx

fn cmp(&self, other: &SmoothTermIdx) -> 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 SmoothTermIdx

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

fn partial_cmp(&self, other: &SmoothTermIdx) -> 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 SmoothTermIdx

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 SmoothTermIdx