Skip to main content

CriterionCertificate

Struct CriterionCertificate 

Source
pub struct CriterionCertificate {
    pub grad_norm: f64,
    pub analytic_directional: f64,
    pub fd_directional: f64,
    pub fd_error: f64,
    pub agreement_z: f64,
    pub fd_step: f64,
    pub hessian_pd: Option<bool>,
    pub lambdas_railed: Vec<usize>,
}
Expand description

First-order optimality certificate: gradient-vs-objective FD audit at the returned optimum (#934).

Answers, machine-checkably, the three questions every objective↔gradient desync postmortem asks: does the analytic gradient match the actual criterion value HERE (Self::first_order_consistent); is the outer curvature positive definite HERE (hessian_pd); did any smoothing coordinate rail to a box bound (lambdas_railed).

Fields§

§grad_norm: f64

‖∇F(θ̂)‖₂ from the analytic gradient path at the returned point.

§analytic_directional: f64

Analytic directional derivative ∇F(θ̂)·v along the audit direction.

§fd_directional: f64

Richardson-extrapolated central difference of the criterion VALUE path along the same direction: (4·D_h − D_2h)/3 from the h and 2h central-difference pairs.

§fd_error: f64

Error bar on fd_directional: the Richardson residual |D_h − D_2h| (which absorbs both truncation and inner-solve value noise) floored by the central-difference roundoff bound ε·|F|/h.

§agreement_z: f64

|analytic − fd| / fd_error — standardized disagreement.

§fd_step: f64

Base central-difference step h along the unit direction.

§hessian_pd: Option<bool>

Whether the final outer Hessian is positive definite at θ̂, when the solver tracked one (None when no final Hessian was available).

§lambdas_railed: Vec<usize>

Leading smoothing coordinates (ρ block) pinned within [CERTIFICATE_RAIL_MARGIN] of either box bound at the optimum.

Implementations§

Source§

impl CriterionCertificate

Source

pub fn first_order_consistent(&self) -> bool

Whether the analytic directional derivative agrees with the finite difference of the actual criterion value at the optimum.

Source

pub fn is_clean(&self) -> bool

Whether every audited fact is clean: gradient matches objective, no definiteness failure, no railed smoothing coordinate.

Source

pub fn summary(&self) -> String

One-line human-readable rendering for logs and reports.

Trait Implementations§

Source§

impl Certificate for CriterionCertificate

Source§

fn claim(&self) -> Claim

What this certificate certifies — stable id + human sentence.
Source§

fn evidence(&self) -> BTreeMap<&'static str, EvidenceValue>

The named evidence quantities behind the claim.
Source§

fn verdict(&self) -> Verdict

The conservative verdict. MUST be derived from the certificate’s own (unchanged) decision rule, and MUST return Verdict::Unavailable / Verdict::Insufficient rather than a silent pass when the evidence is missing or below margin.
Source§

fn ledger_entry(&self) -> LedgerEntry

Fold claim + evidence + verdict into one ledger record.
Source§

impl Clone for CriterionCertificate

Source§

fn clone(&self) -> CriterionCertificate

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CriterionCertificate

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CriterionCertificate

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<CriterionCertificate, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for CriterionCertificate

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V