AveragedGroup

Struct AveragedGroup 

Source
#[non_exhaustive]
pub struct AveragedGroup { pub row: GauntletRow, pub passes_observed: u32, pub skips_observed: u32, pub inconclusives_observed: u32, pub failures_observed: u32, pub total_observed: u32, }
Expand description

Re-export of the comparison-policy types so downstream crates using ktstr::cli as their public surface don’t need to reach into the internal ktstr::stats module (which is pub(crate) — see lib.rs — and therefore not a stable public path). The policy is the only item in stats that a CLI or external consumer constructs directly; every other item is internal plumbing reached via cli::compare_partitions. One aggregated GauntletRow produced by group_and_average_by, plus the pass-bookkeeping needed to render the per-group summary block (N/M passed + the (S skip, I inc, F fail) breakdown).

row carries arithmetic-mean metric values across every real Pass contributor in the group; the (scenario, topology, work_type, scheduler, kernel_version) identity is taken verbatim from the first contributor in iteration order — every contributor in the group shares the identity tuple by construction (scenario, topology, and work_type ARE the group key, and scheduler / kernel_version are typed-filter-narrowed at the call site so they can only vary if the operator passed no --scheduler / --kernel filter).

The verdict bits on row (passed, skipped, inconclusive) fold under the strict 4-state Fail > Inconclusive > Pass > Skip lattice: any failing contributor sets the aggregate to Fail (passed=false, inconclusive=false, skipped=false); else any inconclusive contributor sets inconclusive=true; else any skipped contributor sets skipped=true; only an all-pass cohort yields passed=true. The lattice mechanics match GauntletRow::is_pass’s triple-conjunct, so the aggregated row’s accessor reads honestly. Aggregate rows that are not real Pass route the pair through compare_rows_by’s excluded_pairs gate.

passes_observed, skips_observed, inconclusives_observed, failures_observed and total_observed count contributors per the strict 4-state mutex: the four bucket counters sum to total_observed because every contributor falls into exactly one bucket. Only real Pass contributors feed the per-row sums — failing, inconclusive, and skipped contributors all carry no comparable per-run signal (failure-mode telemetry; “couldn’t evaluate” non-signal; “didn’t run” non-signal). When no contributor passed cleanly the running sum is zero and the aggregate row carries default-zero metric values plus passed = false — the downstream excluded_pairs gate then drops the pair from the regression math.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§row: GauntletRow

Aggregated row carrying arithmetic-mean metric values plus the lattice-folded (passed, skipped, inconclusive) bits matching the Fail > Inconclusive > Pass > Skip dominance. passed is true only when every contributor was a real pass; inconclusive fires when at least one contributor was Inconclusive and none failed; skipped fires when at least one contributor was Skip and none failed or was Inconclusive. Fed directly into compare_rows (averaging is the fixed compare_partitions fold).

§passes_observed: u32

Number of contributors that were a real pass (is_pass() == true). Renders as the numerator of the per-group N/M summary.

§skips_observed: u32

Number of contributors that were Skip (is_skip() == true). Surfaced in the per-group rendering as the “S skipped” breakdown so an operator can distinguish “scenario didn’t run” from real failures.

§inconclusives_observed: u32

Number of contributors that were Inconclusive (is_inconclusive() == true). Surfaced in the per-group rendering as the “I inconclusive” breakdown so an operator can distinguish “couldn’t evaluate” from real failures — same defense-in-depth pattern as format_dimension_summary’s inconc bucket.

§failures_observed: u32

Number of contributors that were a real Fail (is_fail() == true). Surfaced in the per-group rendering as the “F failed” breakdown.

§total_observed: u32

Total contributors in the group (= group.len()). Renders as the denominator of the per-group N/M summary. Mechanically: total_observed == passes_observed + skips_observed + inconclusives_observed + failures_observed under the strict 4-state mutex.

Trait Implementations§

Source§

impl Clone for AveragedGroup

Source§

fn clone(&self) -> AveragedGroup

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AveragedGroup

Source§

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

Formats the value using the given formatter. 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> 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> 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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSend for T
where T: Send,