Skip to main content

AbsenceCensus

Struct AbsenceCensus 

Source
pub struct AbsenceCensus { /* private fields */ }
Expand description

How often each path was absent, counted per occurrence rather than per file.

LabelCensus counts a label once per file, which answers “does the corpus carry this at all”. It cannot answer how often a reader’s absent fallback runs, because a label inside a list is present on some elements and absent on others and a file-level count collapses that to one bit. A corpus of two hundred creatures where one omits ScriptHeartbeat and a corpus where all two hundred omit it are the same file either way.

So the denominator here is the number of structs visited at the path’s parent: the number of times the reader ran at all. A field on a list element gets one occasion per element.

Paths are label sequences with no list marker, so a schema entry looks up directly by the path a walk builds for it. A list and a struct both become the parent path of whatever hangs beneath them, which is the same nesting Shape uses for a container’s children.

Implementations§

Source§

impl AbsenceCensus

Source

pub fn new() -> Self

An empty census.

Source

pub fn observe(&mut self, root: &GffStruct)

Folds one file’s tree into the running counts.

Source

pub fn rate(&self, path: &[&str]) -> Option<AbsenceRate>

How often path was absent, or None when the corpus never reached its parent.

None is not the same as “always present” and not the same as “always absent”. It means no file in the corpus held a struct this field could have appeared on, so the corpus says nothing about the field either way. Ranking that as a 0% firing rate would read as evidence the fallback never runs, which is exactly backwards.

Source

pub fn firing_rate( &self, path: &[&str], shape: SchemaShape, ) -> Option<AbsenceRate>

How often path’s fallback fires in this corpus, or None when this corpus cannot speak to it.

rate answers “how often was the label missing here”, which is not the same question. A missing label only means a fallback ran if this corpus’s reader was the one looking for it, and under SchemaShape::Union it may not have been. Callers deciding that inline have gotten it wrong in both directions:

  • Treating a union schema as single-form counts every static-form label as firing across the entire saved corpus, which put six TemplateResRef rows at the head of a ranking on numbers describing a reader that never ran.
  • Treating a single-form schema as a union drops every field the corpus universally omits, which is exactly the set whose fallback runs every time and therefore matters most.

So the shape is a parameter rather than a heuristic, and this is the only place the rule is written down.

Source

pub fn occurrences(&self, path: &[&str]) -> usize

How many structs the corpus held at path.

The element count of a list, when path names one. Zero for a path the corpus never held.

Trait Implementations§

Source§

impl Clone for AbsenceCensus

Source§

fn clone(&self) -> AbsenceCensus

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 AbsenceCensus

Source§

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

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

impl Default for AbsenceCensus

Source§

fn default() -> AbsenceCensus

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
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<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.