Struct GeneratorVerdict 

pub struct GeneratorVerdict {
    pub family: GeneratorFamily,
    pub description: String,
    pub unpinned: bool,
    pub generator_norm: f64,
    pub pinned_energy_fraction: f64,
    pub lowering_error_scale: f64,
    pub provenance: VerdictProvenance,
}

One enumerated symmetry generator and the certificate’s verdict on it.

Fields

family: GeneratorFamily

Which symmetry family this generator realises.

description: String

Human-readable description (which atom(s) / axes it acts on).

unpinned: bool

true ⇒ the converged objective is flat along this generator (ξ ∈ ker(H)): a genuine residual gauge freedom the data + isometry penalty leave unbroken. false ⇒ the generator is pinned — the data or the isometry penalty gives it curvature (a pinned-energy fraction above GENERATOR_FLAT_ENERGY_TOL).

generator_norm: f64

‖ξ‖₂ of the realised tangent direction (0 ⇒ the generator was structurally trivial — e.g. a rotation of a rank-deficient frame — and is reported as pinned/absent, never as a spurious freedom).

pinned_energy_fraction: f64

‖R ξ̂‖² / σ_max(R)² ∈ [0, 1]: curvature along the unit generator, relative to the stiffest direction of the stacked curvature root R (data + isometry penalty, in the metric). 0 ⇒ exactly flat, 1 ⇒ as stiff as the stiffest direction; strictly-interior values are the mixed regime — partial curvature that breaks the exact symmetry (verdict pinned when above the tolerance) while leaving nearby flat directions, kept visible here rather than collapsed into the boolean. Relative-to-σ_max (not span membership) so the statistic stays informative when the pinning span is full-rank, which production fits always are. Structurally trivial generators (zero norm) report 1.0.

lowering_error_scale: f64

The #995 lowering-error arm of this generator’s verdict tolerance: the largest FittedAtom::lowering_error over the atoms the generator touches (its own atom for within-atom families, the exchanged pair for permutations, all atoms for global output-frame rotations). The verdict is unpinned ⇔ pinned_energy_fraction ≤ max(GENERATOR_FLAT_ENERGY_TOL, lowering_error_scale) — curvature the mean-frame compression cannot distinguish from gauge motion is never read as a pin.

provenance: VerdictProvenance

How this verdict was decided: by the curvature flatness test, or pinned by the #1019 post-fit arc-length chart canonicalization (see VerdictProvenance).

Trait Implementations

impl Clone for GeneratorVerdict

fn clone(&self) -> GeneratorVerdict

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeneratorVerdict

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

Formats the value using the given formatter.