Struct EffectEstimate 

pub struct EffectEstimate {
    pub max_effect_ns: f64,
    pub credible_interval_ns: (f64, f64),
    pub top_quantiles: Vec<TopQuantile>,
}

Estimated timing effect with credible interval and top quantiles.

This struct summarizes the timing difference between baseline and sample classes. The effect is characterized by the maximum absolute quantile difference across all 9 deciles, with a 95% credible interval and details about which quantiles contribute most to any detected leak.

See spec Section 5.2 (Effect Reporting).

Fields

max_effect_ns: f64

Posterior mean of max_k |δ_k| in nanoseconds.

This is the maximum absolute timing difference across all 9 deciles, averaged over posterior samples. Positive values indicate detectable timing differences between the two input classes.

credible_interval_ns: (f64, f64)

95% credible interval for max|δ| in nanoseconds.

This is a Bayesian credible interval: there is a 95% posterior probability that the true maximum effect lies within this range.

top_quantiles: Vec<TopQuantile>

Top 2-3 quantiles by exceedance probability.

When a timing leak is detected, these are the specific quantiles that contribute most to the leak detection. Each entry includes the quantile probability (e.g., 0.9 for 90th percentile), the posterior mean effect, the 95% marginal credible interval, and the exceedance probability.

Empty when no leak is detected or effect is negligible.

Implementations

impl EffectEstimate

pub fn new( max_effect_ns: f64, credible_interval_ns: (f64, f64), top_quantiles: Vec<TopQuantile>, ) -> Self

Create a new EffectEstimate with the given values.

pub fn is_negligible(&self, threshold_ns: f64) -> bool

Check if the effect is negligible (max effect below threshold).

pub fn total_effect_ns(&self) -> f64

Get the total effect magnitude (same as max_effect_ns for API compatibility).

Trait Implementations

impl Clone for EffectEstimate

fn clone(&self) -> EffectEstimate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EffectEstimate

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

Formats the value using the given formatter.

impl Default for EffectEstimate

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EffectEstimate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EffectEstimate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.