stat_bench::plots Namespace Reference

Namespace of plotting. More...

Classes
class	BoxPlot
	Class of box plots. More...
class	CdfLinePlot
	Class of line plots of cumulative distribution functions. More...
class	IPlot
	Class of interface of plots. More...
class	ParameterToOutputLinePlot
	Class of line plots of custom outputs with respect to parameters. More...
class	ParameterToTimeBoxPlot
	Class of box plots of measured times with respect to parameters. More...
class	ParameterToTimeLinePlot
	Class of line plots of measured times with respect to parameters. More...
class	ParameterToTimeViolinPlot
	Class of violin plots of measured times with respect to parameters. More...
class	SamplesLinePlot
	Class of line plots of measured samples of durations. More...
class	TimeToOutputByParameterLinePlot
	Class of line plots of custom outputs with respect to measured processing time while parameter changes. More...
class	ViolinPlot
	Class of violin plots. More...

Functions
auto	create_data_table_for_cdf_plot (const std::vector< measurer::Measurement > &measurements) -> plotly_plotter::data_table
	Create a data table for cumulative distribution functions.
auto	create_data_table_with_all_time (const std::vector< measurer::Measurement > &measurements, const std::vector< param::ParameterName > &parameter_names) -> plotly_plotter::data_table
	Create a data table with all samples of processing time.
auto	create_data_table_with_custom_output (const std::vector< measurer::Measurement > &measurements, const std::vector< param::ParameterName > &parameter_names, const CustomOutputName &output_name) -> std::pair< plotly_plotter::data_table, bool >
	Create a data table with a custom output.
auto	create_data_table_with_mean_time (const std::vector< measurer::Measurement > &measurements, const std::vector< param::ParameterName > &parameter_names) -> plotly_plotter::data_table
	Create a data table with the mean of processing time.
auto	generate_plot_name (const BenchmarkCaseName &case_name, const param::ParameterDict &params) -> util::Utf8String
	Generate a name for a plot.

Variables
constexpr const char *	case_name_label = "Case"
	Label for case names in plots.
constexpr const char *	cumulative_probability_label = "Cumulative Probability"
	Label for cumulative probability in plots.
constexpr const char *	sample_index_label = "Sample Index"
	Label for sample index in plots.
constexpr const char *	time_error_label = "Standard Error of Time [s]"
	Label for errors of processing time in plots.
constexpr const char *	time_label = "Time [s]"
	Label for processing time in plots.

Detailed Description

Namespace of plotting.

Function Documentation

create_data_table_for_cdf_plot()

auto stat_bench::plots::create_data_table_for_cdf_plot ( const std::vector< measurer::Measurement > & measurements ) -> plotly_plotter::data_table

nodiscard

Create a data table for cumulative distribution functions.

Parameters

[in]

measurements

Measurements.

Returns

Created data table.

Definition at line 346 of file create_data_table.cpp.

create_data_table_with_all_time()

auto stat_bench::plots::create_data_table_with_all_time ( const std::vector< measurer::Measurement > & measurements, const std::vector< param::ParameterName > & parameter_names ) -> plotly_plotter::data_table

nodiscard

Create a data table with all samples of processing time.

Parameters

[in]	measurements	Measurements.
[in]	parameter_names	Names of parameters to include in the table.

Returns

Created data table.

Definition at line 291 of file create_data_table.cpp.

create_data_table_with_custom_output()

auto stat_bench::plots::create_data_table_with_custom_output ( const std::vector< measurer::Measurement > & measurements, const std::vector< param::ParameterName > & parameter_names, const CustomOutputName & output_name ) -> std::pair< plotly_plotter::data_table, bool >

nodiscard

Create a data table with a custom output.

Parameters

[in]	measurements	Measurements.
[in]	parameter_names	Names of parameters to include in the table.
[in]	output_name	Name of the custom output to include in the table.

Returns

Created data table and whether custom output has errors.

Definition at line 272 of file create_data_table.cpp.

create_data_table_with_mean_time()

auto stat_bench::plots::create_data_table_with_mean_time ( const std::vector< measurer::Measurement > & measurements, const std::vector< param::ParameterName > & parameter_names ) -> plotly_plotter::data_table

nodiscard

Create a data table with the mean of processing time.

Parameters

[in]	measurements	Measurements.
[in]	parameter_names	Names of parameters to include in the table.

Returns

Created data table.

Definition at line 101 of file create_data_table.cpp.

generate_plot_name()

auto stat_bench::plots::generate_plot_name ( const BenchmarkCaseName & case_name, const param::ParameterDict & params ) -> util::Utf8String

nodiscard

Generate a name for a plot.

Parameters

[in]	case_name	Benchmark case name.
[in]	params	Parameters.

Returns

Name for the plot.

Definition at line 27 of file plot_utils.cpp.

Variable Documentation

case_name_label

const char* stat_bench::plots::case_name_label = "Case"

constexpr

Label for case names in plots.

Definition at line 28 of file common_labels.h.

cumulative_probability_label

const char* stat_bench::plots::cumulative_probability_label = "Cumulative Probability"

constexpr

Label for cumulative probability in plots.

Definition at line 48 of file common_labels.h.

sample_index_label

const char* stat_bench::plots::sample_index_label = "Sample Index"

constexpr

Label for sample index in plots.

Definition at line 43 of file common_labels.h.

time_error_label

const char* stat_bench::plots::time_error_label = "Standard Error of Time [s]"

constexpr

Label for errors of processing time in plots.

Definition at line 38 of file common_labels.h.

time_label

const char* stat_bench::plots::time_label = "Time [s]"

constexpr

Label for processing time in plots.

Definition at line 33 of file common_labels.h.