Enum NodeObservation 

pub enum NodeObservation {
    Untouched,
    Select {
        saw_true: bool,
        saw_false: bool,
    },
    Compare {
        saw_true: bool,
        saw_false: bool,
    },
    Clamp {
        peak_fraction_of_bound: f32,
        hops_at_bound: u32,
        hops: u32,
    },
}

What one AST node did across a run.

Variants

Untouched

Never evaluated — either not a comparison/select()/clamp(), or inside a branch the run never took.

Select

A select() condition: did it ever go each way?

Fields

saw_true: bool

The condition evaluated non-zero at least once.

saw_false: bool

The condition evaluated zero at least once.

Compare

A comparison operator (> < >= <= == !=), wherever it sits in the tree. Same two-valued shape as Select — deliberately, so the reporting logic is shared (ADR-0043). A comparison that is the direct condition of a select() is still observed here; it is reporting that suppresses it, because the select() names it in better words.

Fields

saw_true: bool

The comparison evaluated true at least once.

saw_false: bool

The comparison evaluated false at least once.

Clamp

A clamp(): how close the inner value came to the upper bound, and how long it sat there. The two are opposite ends of one measurement (ADR-0062). A peak below 1.0 across a whole run means the bound never bit at this stimulus — the ceiling is decorative and the parameter’s real range is narrower than the preset reads. An occupancy near 1.0 means the opposite and worse thing: the bound bit and never let go, so the binding is an arithmetic expression that has become a constant.

Fields

peak_fraction_of_bound: f32

Peak of value / upper_bound over the run.

hops_at_bound: u32

Hops where the inner value reached the upper bound.

hops: u32

Hops this clamp was evaluated on at all — the denominator of occupancy.

Implementations

impl NodeObservation

pub fn occupancy(self) -> f32

The fraction of evaluated hops a clamp() spent at its upper bound; 0.0 for anything that is not a clamp, and for a clamp no hop reached.

Trait Implementations

impl Clone for NodeObservation

fn clone(&self) -> NodeObservation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeObservation

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

Formats the value using the given formatter.

impl Default for NodeObservation

fn default() -> NodeObservation

Returns the “default value” for a type.

impl PartialEq for NodeObservation

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

impl StructuralPartialEq for NodeObservation