pulsatrix 1.1.0
Loading...
Searching...
No Matches
pulsatrix::BenchmarkComparison Struct Reference

One record compared across two builds. More...

#include <benchmark.hpp>

Public Attributes

std::string name
 
std::string device
 
BenchmarkRecord::Kind kind = BenchmarkRecord::Kind::Time
 
double baseline = 0.0
 The baseline's and candidate's median time (median over runs of each run's median), or their metric value (median over runs).
 
double candidate = 0.0
 
double change = 0.0
 candidate / baseline - 1 for times; candidate - baseline for metrics.
 
bool regression = false
 
double p_value = 0.0
 For times with at least three rounds per side: the one-sided Mann-Whitney U test's p-value that the candidate's rounds are no slower than the baseline's. NaN otherwise.
 
std::string missing_from
 Set when the record is in only one of the two builds' reports.
 

Detailed Description

One record compared across two builds.

Member Data Documentation

◆ baseline

double pulsatrix::BenchmarkComparison::baseline = 0.0

The baseline's and candidate's median time (median over runs of each run's median), or their metric value (median over runs).

◆ candidate

double pulsatrix::BenchmarkComparison::candidate = 0.0

◆ change

double pulsatrix::BenchmarkComparison::change = 0.0

candidate / baseline - 1 for times; candidate - baseline for metrics.

◆ device

std::string pulsatrix::BenchmarkComparison::device

◆ kind

BenchmarkRecord::Kind pulsatrix::BenchmarkComparison::kind = BenchmarkRecord::Kind::Time

◆ missing_from

std::string pulsatrix::BenchmarkComparison::missing_from

Set when the record is in only one of the two builds' reports.

◆ name

std::string pulsatrix::BenchmarkComparison::name

◆ p_value

double pulsatrix::BenchmarkComparison::p_value = 0.0

For times with at least three rounds per side: the one-sided Mann-Whitney U test's p-value that the candidate's rounds are no slower than the baseline's. NaN otherwise.

◆ regression

bool pulsatrix::BenchmarkComparison::regression = false

The documentation for this struct was generated from the following file: