Enum Provenance 

#[non_exhaustive]
pub enum Provenance {
    Ladder(Box<CurveProvenance>),
    Withheld {
        scheme: Interpolation,
        reason: &'static str,
    },
}

What a converged solve knows about the ladder behind its curve.

A CurveProvenance is deliberately whole — rungs and ∂z/∂q, because one without the other is a half-thing that passes the rung-count check at pinning and then has no row for any pillar to land on. So a scheme that cannot report a Jacobian does not get a hollowed-out provenance: it gets none, and this enum carries the reason in its place.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Ladder(Box<CurveProvenance>)

The ladder and the Jacobian it implies.

Withheld

The scheme’s coefficients are solved passively, so ∂z/∂q taken through them would be frozen against the very quantities a par risk pass differentiates. The curve is sound — the residual that produced it was exact — but what it implies for par risk cannot be stated.

Fields

scheme: Interpolation

The scheme solved under.

reason: &'static str

Its own reason, from Interpolation::adjoint_refusal.

Implementations

impl Provenance

pub fn ladder(&self) -> Option<&CurveProvenance>

The ladder, if one could be reported.

pub fn refusal(&self) -> Option<&'static str>

Why no ladder is reported, if none is.

Trait Implementations

impl Clone for Provenance

fn clone(&self) -> Provenance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Provenance

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

Formats the value using the given formatter.

impl PartialEq for Provenance

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