fcf::NTest::DurationBasic class
Type:
template <typename TClock>
classfcf::NTest::DurationBasic
class
Package: fcfTest
File: test.hpp ( link_to_the_text_position_in_the_file )
Available from version: 1.2.5
A template-based benchmarking class that provides multi-level measurement, warmup iterations, and statistical analysis using histograms.
The
Key features include:
- Multi-level timing: Measure nested code blocks at different depths.
- Warmup support: Execute code multiple times before actual measurement to account for CPU cache warming and JIT optimizations.
- Statistical analysis: Automatically collects data into
fcf::NTest::HistogramBasic for calculating average, median, minimum, and maximum durations. - Flexible execution: Supports both manual control via
begin /end and automated execution using theoperator() with a provided functor.
Template arguments
Nested classes
- A configuration structure used to define the initial parameters for a measurement session in the DurationBasic class, such as iteration count and histogram resolution.
- An extended configuration structure for benchmarking sessions, providing fine-grained control over iterations, warmup, measurement steps, and histogram resolution.
Methods
[CONSTRUCTOR]
DurationBasic ()
[CONSTRUCTOR]
DurationBasic (unsigned long long a_iterationCount, unsigned long long a_measurementStep = 1, unsigned long long a_warmupCount = 0)
- Initializes a new benchmarking session with specified iteration and measurement parameters.
- Starts a measurement session at a specific level.
- Returns the total accumulated duration for a specific level.
- Executes a function and measures its duration.
- Returns the average duration for a specific level.
- Returns the minimum duration recorded for a specific level.
- Returns the maximum duration recorded for a specific level.
- Returns the median duration for a specific level using the internal histogram.
Example: Automated Benchmarking with Warmup
Demonstrates the most efficient way to benchmark a function using the operator() overload, including warmup iterations and statistical reporting.
#define FCF_TEST_IMPLEMENTATION
#include <fcfTest/test.hpp>
#include <vector>
#include <algorithm>
FCF_TEST_DEFINE ("Benchmark", "Performance", "SortTest"){
// 1. Configure measurement options:
// - 1000 total iterations
// - 100 warmup iterations to stabilize the environment
// - 50 iterations per measurement step
// - 20 bins for the histogram
fcf::NTest::Duration::Options options(1000, 20, 50, 100);
// 2. Create the duration object with specified options
fcf::NTest::Duration bench(options);bench std::vector<int> data(100);
for(int i = 0; i < 100; ++i) data[i] = i;
std::sort (data.begin(), data.end());
});
// 4. Report the statistical results
fcf::NTest::log () << "--- Benchmark Results ---" << std::endl;
fcf::NTest::log () << "Average: " << bench.average () << std::endl;
fcf::NTest::log () << "Median: " << bench.median () << std::endl;
fcf::NTest::log () << "Min: " << bench.min () << std::endl;
fcf::NTest::log () << "Max: " << bench.max () << std::endl;
}
int main(int a_argc, char* a_argv[]) {
bool error = false;
fcf::NTest::cmdRun (a_argc, a_argv, fcf::NTest::CRM_RUN , &error);
return error ? 1 : 0;
}
Output:
Performing the test: "Benchmark" -> "Performance" -> "SortTest" ...
> --- Benchmark Results ---
> Average: 0.000`001`234 sec
> Median: 0.000`001`210 sec
> Min: 0.000`000`980 sec
> Max: 0.000`002`450 sec
[SUCCESS] Test completed successfully (0.001`234`567 sec)
[SUCCESS] All tests were completed.
Tests: 1 passed, 0 failed, 0 skipped, 1 total
Duration: 0.001`234`567 sec
VPSDime is an industry leading VPS hosting company that provides virtualized server services with high performance, availability and friendly support.