Struct SpreadRow 

pub struct SpreadRow {
    pub output: String,
    pub unit: String,
    pub spread: f64,
    pub tolerance: f64,
    pub floor: f64,
    pub held_out_within: usize,
    pub adjacent_ratio: Option<f64>,
    pub lag1_autocorrelation: Option<f64>,
}

The spread of one output.

Fields

output: String

The output: a ClipOutput name, or the path of a number in the layer report, such as stem.rms_dbfs.

unit: String

The unit of the output, of its spread and of its tolerance.

spread: f64

The SPREAD_QUANTILE of the distances over every pair of renders: how far two renders lie apart.

tolerance: f64

The leave-one-out median at rank tolerance_rank: for each render, the median of its distances from the other renders. A clip compares with the renders against it.

floor: f64

The least tolerance a comparison uses, so float noise on an output that every render repeats does not count as a difference. Always positive.

held_out_within: usize

How many renders lie within the limit of the other renders, each held out in turn and compared as a clip: a check of the coverage that tolerance_rank states.

adjacent_ratio: Option<f64>

A diagnostic of the draws: the median distance of the renders next to each other in the sequence over the median distance of all pairs. Near 1 when a draw does not depend on the one before; absent when every pair is 0. With 19 adjacent pairs it is noisy.

lag1_autocorrelation: Option<f64>

A diagnostic of the draws: the lag-1 autocorrelation of the output’s value over the sequence, lag1_autocorrelation. Absent for an output of two clips and for a value that every render repeats.

Implementations

impl SpreadRow

pub fn of( output: &str, unit: &str, count: usize, distance: impl Fn(usize, usize) -> f64, values: Option<&[f64]>, floor: f64, ) -> Option<Self>

The spread row of count renders whose pairwise distances distance gives, with the output’s values in draw order when it has one per render.

Returns None for fewer than MIN_RUNS renders, for a floor that is not positive and finite, which would let a difference over a limit of 0 be no number, and for a distance that is not finite.

pub fn of_values( output: &str, unit: &str, values: &[f64], floor: f64, ) -> Option<Self>

The spread row of a scalar output from its value in each render, in draw order. Returns None as SpreadRow::of does.

pub fn limit(&self) -> f64

The tolerance a comparison uses: the larger of SpreadRow::tolerance and SpreadRow::floor.

Trait Implementations

impl Clone for SpreadRow

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpreadRow

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

Formats the value using the given formatter.

impl PartialEq for SpreadRow

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SpreadRow

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SpreadRow