Enum FixedPointCoordinateCertificate 

pub enum FixedPointCoordinateCertificate {
    Covered {
        update: f64,
        scale: f64,
    },
    Uncovered {
        reason: String,
    },
}

One coordinate of an objective-supplied final fixed-point certificate.

Covered means the objective has an analytic update equation whose zero is equivalent to stationarity for this coordinate. update is the signed feasible-descent update in the coordinate’s native parameterization and scale makes its residual dimensionless. A guarded zero, an unavailable trace, or a coordinate with no fixed-point equation must be Uncovered; representing any of those as Covered { update: 0, .. } would fabricate a convergence certificate.

Variants

Covered

Fields

update: f64

scale: f64

Uncovered

Fields

reason: String

Implementations

impl FixedPointCoordinateCertificate

pub fn covered(update: f64, scale: f64) -> Self

pub fn uncovered(reason: impl Into<String>) -> Self

Trait Implementations

impl Clone for FixedPointCoordinateCertificate

fn clone(&self) -> FixedPointCoordinateCertificate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FixedPointCoordinateCertificate

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

Formats the value using the given formatter.