#include <unity/scopes/testing/Benchmark.h>
Timing characteristics captured during the benchmark run.
All timing-based results are measures in fractional seconds.
void unity::scopes::testing::Benchmark::Result::Timing::enumerate |
( |
const Sample::Enumerator & |
enumerator | ) |
const |
|
virtual |
bool unity::scopes::testing::Benchmark::Result::Timing::is_significantly_faster_than_reference |
( |
const Timing & |
reference, |
|
|
double |
alpha = 0.05 |
|
) |
| const |
Checks if a timing sample is statistically significantly faster than a reference timing sample.
- Exceptions
-
std::runtime_error | if either this sample or the reference sample is not normally distributed. |
- Parameters
-
reference | The reference timing sample to compare to. |
alpha | The critical value of the statistical test. The lower, the higher the relevance of the test. |
- Returns
- true iff this timing sample is significantly faster than the reference sample.
bool unity::scopes::testing::Benchmark::Result::Timing::is_significantly_faster_than_reference |
( |
double |
mean, |
|
|
double |
std_dev, |
|
|
double |
alpha = 0.05 |
|
) |
| const |
Checks if a timing sample is statistically significantly faster than a reference timing with mean 'mean and std. dev. 'std_dev'.
- Exceptions
-
std::runtime_error | if this sample is not normally distributed. |
- Parameters
-
mean | The reference mean to compare to. |
std_dev | The reference std. dev. to compare to. |
alpha | The critical value of the statistical test. The lower, the higher the relevance of the test. |
- Returns
- true iff this timing sample is significantly faster than the reference sample.
bool unity::scopes::testing::Benchmark::Result::Timing::is_significantly_slower_than_reference |
( |
const Timing & |
reference, |
|
|
double |
alpha = 0.05 |
|
) |
| const |
Checks if a timing sample is statistically significantly slower than a reference timing sample.
- Exceptions
-
std::runtime_error | if either this sample or the reference sample is not normally distributed. |
- Parameters
-
reference | The reference timing sample to compare to. |
alpha | The critical value of the statistical test. The lower, the higher the relevance of the test. |
- Returns
- true iff this timing sample is significantly slower than the reference.
bool unity::scopes::testing::Benchmark::Result::Timing::is_significantly_slower_than_reference |
( |
double |
mean, |
|
|
double |
std_dev, |
|
|
double |
alpha = 0.05 |
|
) |
| const |
Checks if a timing sample is statistically significantly slower than a reference timing with mean 'mean and std. dev. 'std_dev'.
- Exceptions
-
std::runtime_error | if this sample is not normally distributed. |
- Parameters
-
mean | The reference mean to compare to. |
std_dev | The reference std. dev. to compare to. |
alpha | The critical value of the statistical test. The lower, the higher the relevance of the test. |
- Returns
- true iff this timing sample is significantly slower than the reference.
std::vector<std::pair<Seconds, double> > unity::scopes::testing::Benchmark::Result::Timing::histogram {} |
Histogram of measured execution times for the benchmarked operation.
Seconds unity::scopes::testing::Benchmark::Result::Timing::kurtosis {Seconds::min()} |
Kurtosis in execution time for the benchmarked operation.
Seconds unity::scopes::testing::Benchmark::Result::Timing::max {Seconds::min()} |
Maximum execution time for the benchmarked operation.
Seconds unity::scopes::testing::Benchmark::Result::Timing::mean {Seconds::min()} |
Mean execution time for the benchmarked operation.
Seconds unity::scopes::testing::Benchmark::Result::Timing::min {Seconds::min()} |
Minimum execution time for the benchmarked operation.
std::vector<Seconds> unity::scopes::testing::Benchmark::Result::Timing::sample {} |
Raw sample vector, with sample.size() == sample_size
Seconds unity::scopes::testing::Benchmark::Result::Timing::skewness {Seconds::min()} |
Skewness in execution time for the benchmarked operation.
Seconds unity::scopes::testing::Benchmark::Result::Timing::std_dev {Seconds::min()} |
Std. deviation in execution time for the benchmarked operation.
The documentation for this struct was generated from the following files:
- include/unity/scopes/testing/Benchmark.h
- src/scopes/testing/Benchmark.cpp