stat_bench::bench_impl::BenchmarkGroupRegister Class Reference

Class to register benchmark groups. More...

#include <stat_bench/bench_impl/benchmark_group_register.h>

Collaboration diagram for stat_bench::bench_impl::BenchmarkGroupRegister:

Public Member Functions
	BenchmarkGroupRegister (const BenchmarkGroupName &name) noexcept
	Constructor.
auto	add_parameter_to_output_line_plot (util::StringView parameter_name, util::StringView custom_output_name, PlotOptions options=PlotOptions()) noexcept -> BenchmarkGroupRegister &
	Add a line plot of a custom output with respect to a parameter to the group.
auto	add_parameter_to_time_box_plot (util::StringView parameter_name, PlotOptions options=PlotOptions()) noexcept -> BenchmarkGroupRegister &
	Add a box plot of processing time with respect to a parameter to the group.
auto	add_parameter_to_time_line_plot (util::StringView parameter_name, PlotOptions options=PlotOptions()) noexcept -> BenchmarkGroupRegister &
	Add a line plot of processing time with respect to a parameter to the group.
auto	add_parameter_to_time_line_plot_log (util::StringView parameter_name) noexcept -> BenchmarkGroupRegister &
	Add a line plot of processing time with respect to a parameter in the log scale to the group.
auto	add_parameter_to_time_violin_plot (util::StringView parameter_name, PlotOptions options=PlotOptions()) noexcept -> BenchmarkGroupRegister &
	Add a violin plot of processing time with respect to a parameter to the group.
auto	add_time_to_output_by_parameter_line_plot (util::StringView parameter_name, util::StringView custom_output_name, PlotOptions options=PlotOptions()) noexcept -> BenchmarkGroupRegister &
	Add a line plot of a custom output with respect to processing time while parameter changes.

Detailed Description

Class to register benchmark groups.

Definition at line 33 of file benchmark_group_register.h.

Constructor & Destructor Documentation

BenchmarkGroupRegister()

stat_bench::bench_impl::BenchmarkGroupRegister::BenchmarkGroupRegister ( const BenchmarkGroupName & name )

explicitnoexcept

Constructor.

Parameters

[in]

name

Name of the group.

Definition at line 43 of file benchmark_group_register.cpp.

Member Function Documentation

add_parameter_to_output_line_plot()

auto stat_bench::bench_impl::BenchmarkGroupRegister::add_parameter_to_output_line_plot ( util::StringView parameter_name, util::StringView custom_output_name, PlotOptions options = PlotOptions() ) -> BenchmarkGroupRegister&

noexcept

Add a line plot of a custom output with respect to a parameter to the group.

Parameters

[in]	parameter_name	Parameter name.
[in]	custom_output_name	Custom output name.
[in]	options	Options for the plot.

Returns

Reference to this object.

Definition at line 111 of file benchmark_group_register.cpp.

add_parameter_to_time_box_plot()

auto stat_bench::bench_impl::BenchmarkGroupRegister::add_parameter_to_time_box_plot ( util::StringView parameter_name, PlotOptions options = PlotOptions() ) -> BenchmarkGroupRegister&

noexcept

Add a box plot of processing time with respect to a parameter to the group.

Parameters

[in]	parameter_name	Parameter name.
[in]	options	Options for the plot.

Returns

Reference to this object.

Definition at line 94 of file benchmark_group_register.cpp.

add_parameter_to_time_line_plot()

auto stat_bench::bench_impl::BenchmarkGroupRegister::add_parameter_to_time_line_plot ( util::StringView parameter_name, PlotOptions options = PlotOptions() ) -> BenchmarkGroupRegister&

noexcept

Add a line plot of processing time with respect to a parameter to the group.

Parameters

[in]	parameter_name	Parameter name.
[in]	options	Options for the plot.

Returns

Reference to this object.

Definition at line 54 of file benchmark_group_register.cpp.

add_parameter_to_time_line_plot_log()

auto stat_bench::bench_impl::BenchmarkGroupRegister::add_parameter_to_time_line_plot_log ( util::StringView parameter_name ) -> BenchmarkGroupRegister&

noexcept

Add a line plot of processing time with respect to a parameter in the log scale to the group.

Parameters

[in]

parameter_name

Parameter name.

Returns

Reference to this object.

Deprecated

This function is deprecated in favor of add_parameter_to_time_line_plot() function.

Definition at line 71 of file benchmark_group_register.cpp.

add_parameter_to_time_violin_plot()

auto stat_bench::bench_impl::BenchmarkGroupRegister::add_parameter_to_time_violin_plot ( util::StringView parameter_name, PlotOptions options = PlotOptions() ) -> BenchmarkGroupRegister&

noexcept

Add a violin plot of processing time with respect to a parameter to the group.

Parameters

[in]	parameter_name	Parameter name.
[in]	options	Options for the plot.

Returns

Reference to this object.

Definition at line 77 of file benchmark_group_register.cpp.

add_time_to_output_by_parameter_line_plot()

auto stat_bench::bench_impl::BenchmarkGroupRegister::add_time_to_output_by_parameter_line_plot ( util::StringView parameter_name, util::StringView custom_output_name, PlotOptions options = PlotOptions() ) -> BenchmarkGroupRegister&

noexcept

Add a line plot of a custom output with respect to processing time while parameter changes.

Parameters

[in]	parameter_name	Parameter name.
[in]	custom_output_name	Custom output name.
[in]	options	Options for the plot.

Returns

Reference to this object.

Definition at line 130 of file benchmark_group_register.cpp.

---

The documentation for this class was generated from the following files:

• include/stat_bench/bench_impl/benchmark_group_register.h
• src/stat_bench/bench_impl/benchmark_group_register.cpp