iai_callgrind_runner::runner::tool::regression

Trait RegressionConfig

Source 
pub trait RegressionConfig<T: Hash + Eq + Summarize + Display + Clone> {
    // Required methods
    fn check(&self, metrics_summary: &MetricsSummary<T>) -> Vec<ToolRegression>;
    fn get_hard_limits(&self) -> &[(T, Metric)];
    fn get_soft_limits(&self) -> &[(T, f64)];

    // Provided methods
    fn check_and_print(
        &self,
        metrics_summary: &MetricsSummary<T>,
    ) -> Vec<ToolRegression> { ... }
    fn check_regressions(
        &self,
        metrics_summary: &MetricsSummary<T>,
    ) -> Vec<RegressionMetrics<T>> { ... }
}
Available on crate feature runner only.
Expand description

The trait which needs to be implemented in a tool specific regression check configuration

Required Methods§

Source

fn check(&self, metrics_summary: &MetricsSummary<T>) -> Vec<ToolRegression>

Check the MetricsSummary for regressions.

The limits for event kinds which are not present in the MetricsSummary are ignored.

Source

fn get_hard_limits(&self) -> &[(T, Metric)]

Return the hard limits

Source

fn get_soft_limits(&self) -> &[(T, f64)]

Return the soft limits

Provided Methods§

Source

fn check_and_print( &self, metrics_summary: &MetricsSummary<T>, ) -> Vec<ToolRegression>

Check for regressions and print them if present

Source

fn check_regressions( &self, metrics_summary: &MetricsSummary<T>, ) -> Vec<RegressionMetrics<T>>

Check for regressions and return the RegressionMetrics

Implementors§