chebyshev/benchmark__structures_8h_source.html

 #ifndef CHEBYSHEV_BENCHMARK_STRUCTURES_H

 #define CHEBYSHEV_BENCHMARK_STRUCTURES_H


 #include <functional>

 #include <map>


 #include "../core/common.h"

 #include "./generator.h"


 namespace chebyshev {


     namespace benchmark {


         struct benchmark_result {


             std::string name = "unknown";


             unsigned int runs = 0;


             unsigned int iterations = 0;


             long double totalRuntime = get_nan<long double>();


             long double averageRuntime = get_nan<long double>();


             long double stdevRuntime = get_nan<long double>();


             long double runsPerSecond = get_nan<long double>();


             bool failed = true;


             bool quiet = false;


             std::map<std::string, long double> additionalFields {};


         };


         template<typename InputType>

         using InputGenerator = std::function<InputType(unsigned int)>;


         template<typename InputType = double>

         struct benchmark_options {


             unsigned int runs = CHEBYSHEV_BENCHMARK_RUNS;


             unsigned int iterations = CHEBYSHEV_BENCHMARK_ITER;


             InputGenerator<InputType> inputGenerator = generator::uniform1D(0, 1);


             bool quiet = false;


             benchmark_options() {}


             benchmark_options(unsigned int runs, unsigned int iterations, bool quiet = false)

             : runs(runs), iterations(iterations), quiet(quiet) {}


             benchmark_options(

                 unsigned int runs,

                 unsigned int iterations,

                 InputGenerator<InputType> gen,

                 bool quiet = false)

             : runs(runs), iterations(iterations), inputGenerator(gen), quiet(quiet) {}


         };


     }

 }


 #endif

CHEBYSHEV_BENCHMARK_ITER
#define CHEBYSHEV_BENCHMARK_ITER
Default number of benchmark iterations.
Definition: common.h:22

CHEBYSHEV_BENCHMARK_RUNS
#define CHEBYSHEV_BENCHMARK_RUNS
Default number of benchmark runs.
Definition: common.h:27

generator.h
Input generators for benchmarks.

chebyshev::benchmark::generator::uniform1D
auto uniform1D(long double a, long double b)
Uniform generator over a domain.
Definition: generator.h:21

chebyshev::benchmark::benchmark
void benchmark(const std::string &name, Function func, const std::vector< InputType > &input, unsigned int runs=settings.defaultRuns, bool quiet=false)
Run a benchmark on a generic function, with the given input vector.
Definition: benchmark.h:187

chebyshev::benchmark::InputGenerator
std::function< InputType(unsigned int)> InputGenerator
A function which takes in an index and returns a generated input element.
Definition: benchmark_structures.h:62

chebyshev::random::string
std::string string(size_t length)
Generate a random string made of human-readable ASCII characters.
Definition: random.h:102

chebyshev
General namespace of the framework.
Definition: benchmark_structures.h:16

chebyshev::benchmark::benchmark_options
A structure holding the options of a benchmark.
Definition: benchmark_structures.h:68

chebyshev::benchmark::benchmark_options::benchmark_options
benchmark_options(unsigned int runs, unsigned int iterations, bool quiet=false)
Construct benchmark options from the number of runs and iterations and whether to print the case to o...
Definition: benchmark_structures.h:88

chebyshev::benchmark::benchmark_options::iterations
unsigned int iterations
Number of iterations.
Definition: benchmark_structures.h:74

chebyshev::benchmark::benchmark_options::quiet
bool quiet
Whether to print to standard output or not.
Definition: benchmark_structures.h:80

chebyshev::benchmark::benchmark_options::benchmark_options
benchmark_options()
Default constructor for benchmark options.
Definition: benchmark_structures.h:84

chebyshev::benchmark::benchmark_options::runs
unsigned int runs
Number of runs (run with the same input values).
Definition: benchmark_structures.h:71

chebyshev::benchmark::benchmark_options::inputGenerator
InputGenerator< InputType > inputGenerator
The function to use to generate input for the benchmark.
Definition: benchmark_structures.h:77

chebyshev::benchmark::benchmark_options::benchmark_options
benchmark_options(unsigned int runs, unsigned int iterations, InputGenerator< InputType > gen, bool quiet=false)
Construct benchmark options from the number of runs and iterations, the input generator to use and wh...
Definition: benchmark_structures.h:93

chebyshev::benchmark::benchmark_result
Structure holding the results of a benchmark.
Definition: benchmark_structures.h:23

chebyshev::benchmark::benchmark_result::quiet
bool quiet
Whether to print to standard output or not.
Definition: benchmark_structures.h:51

chebyshev::benchmark::benchmark_result::averageRuntime
long double averageRuntime
Estimated average runtime.
Definition: benchmark_structures.h:38

chebyshev::benchmark::benchmark_result::failed
bool failed
Whether the benchmark failed because an exception was thrown.
Definition: benchmark_structures.h:48

chebyshev::benchmark::benchmark_result::runs
unsigned int runs
Number of runs.
Definition: benchmark_structures.h:29

chebyshev::benchmark::benchmark_result::iterations
unsigned int iterations
Number of iterations.
Definition: benchmark_structures.h:32

chebyshev::benchmark::benchmark_result::runsPerSecond
long double runsPerSecond
Number of runs per second.
Definition: benchmark_structures.h:44

chebyshev::benchmark::benchmark_result::totalRuntime
long double totalRuntime
Total runtime over all runs and iterations.
Definition: benchmark_structures.h:35

chebyshev::benchmark::benchmark_result::name
std::string name
Identifying name of the function or test case.
Definition: benchmark_structures.h:26

chebyshev::benchmark::benchmark_result::additionalFields
std::map< std::string, long double > additionalFields
Additional fields in floating point representation.
Definition: benchmark_structures.h:54

chebyshev::benchmark::benchmark_result::stdevRuntime
long double stdevRuntime
Sample standard deviation of the runtime.
Definition: benchmark_structures.h:41