cpp-stat-bench 0.24.0
Benchmark library with statistics for C++.
Loading...
Searching...
No Matches
stat_bench::runner::Config Struct Reference

Class of configurations. More...

#include <stat_bench/runner/config.h>

+ Collaboration diagram for stat_bench::runner::Config:

Public Attributes

std::string compressed_msgpack_file_path {}
 File path of compressed MsgPack data file.
 
std::vector< std::string > exclude_glob {}
 Glob patterns of benchmark names to exclude.
 
std::vector< std::string > exclude_regex {}
 Regular expressions of benchmark names to exclude.
 
std::vector< std::string > include_glob {}
 Glob patterns of benchmark names to include.
 
std::vector< std::string > include_regex {}
 Regular expressions of benchmark names to include.
 
std::string json_file_path {}
 File path of JSON data file.
 
std::size_t mean_processing_time_samples
 Number of samples for measurements of mean processing time.
 
double min_sample_duration_sec {impl::default_min_sample_duration_sec}
 Minimum duration of a sample for measurement of mean processing time. [sec].
 
double min_warming_up_duration_sec
 Minimum duration for warming up. [sec].
 
std::size_t min_warming_up_iterations
 Minimum number of iterations for warming up.
 
std::string msgpack_file_path {}
 File path of MsgPack data file.
 
std::string plot_prefix {}
 Prefix of filepaths to generate plots.
 
std::size_t processing_time_samples {impl::default_processing_time_samples}
 Number of samples for measurements of processing time.
 
bool show_help {false}
 Whether to show help.
 

Detailed Description

Class of configurations.

Definition at line 54 of file config.h.

Member Data Documentation

◆ compressed_msgpack_file_path

std::string stat_bench::runner::Config::compressed_msgpack_file_path {}

File path of compressed MsgPack data file.

Empty string specifies no output.

Definition at line 105 of file config.h.

◆ exclude_glob

std::vector<std::string> stat_bench::runner::Config::exclude_glob {}

Glob patterns of benchmark names to exclude.

Definition at line 111 of file config.h.

◆ exclude_regex

std::vector<std::string> stat_bench::runner::Config::exclude_regex {}

Regular expressions of benchmark names to exclude.

Definition at line 117 of file config.h.

◆ include_glob

std::vector<std::string> stat_bench::runner::Config::include_glob {}

Glob patterns of benchmark names to include.

Definition at line 108 of file config.h.

◆ include_regex

std::vector<std::string> stat_bench::runner::Config::include_regex {}

Regular expressions of benchmark names to include.

Definition at line 114 of file config.h.

◆ json_file_path

std::string stat_bench::runner::Config::json_file_path {}

File path of JSON data file.

Empty string specifies no output.

Definition at line 91 of file config.h.

◆ mean_processing_time_samples

std::size_t stat_bench::runner::Config::mean_processing_time_samples
Initial value:
{
static constexpr std::size_t default_mean_processing_time_samples
Default number of samples for measurement of mean processing time.
Definition config.h:35

Number of samples for measurements of mean processing time.

Definition at line 62 of file config.h.

◆ min_sample_duration_sec

double stat_bench::runner::Config::min_sample_duration_sec {impl::default_min_sample_duration_sec}

Minimum duration of a sample for measurement of mean processing time. [sec].

Definition at line 69 of file config.h.

◆ min_warming_up_duration_sec

double stat_bench::runner::Config::min_warming_up_duration_sec
Initial value:
{
static constexpr double default_min_warming_up_duration_sec
Default minimum duration for warming up. [sec].
Definition config.h:47

Minimum duration for warming up. [sec].

Definition at line 76 of file config.h.

◆ min_warming_up_iterations

std::size_t stat_bench::runner::Config::min_warming_up_iterations
Initial value:
{
static constexpr std::size_t default_min_warming_up_iterations
Default minimum number of iterations for warming up.
Definition config.h:44

Minimum number of iterations for warming up.

Definition at line 72 of file config.h.

◆ msgpack_file_path

std::string stat_bench::runner::Config::msgpack_file_path {}

File path of MsgPack data file.

Empty string specifies no output.

Definition at line 98 of file config.h.

◆ plot_prefix

std::string stat_bench::runner::Config::plot_prefix {}

Prefix of filepaths to generate plots.

Empty string specifies no output.

Definition at line 84 of file config.h.

◆ processing_time_samples

std::size_t stat_bench::runner::Config::processing_time_samples {impl::default_processing_time_samples}

Number of samples for measurements of processing time.

Definition at line 59 of file config.h.

◆ show_help

bool stat_bench::runner::Config::show_help {false}

Whether to show help.

Definition at line 56 of file config.h.


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