stat_bench::plots::ParameterToTimeBoxPlot Class Reference

Class of box plots of measured times with respect to parameters. More...

#include <stat_bench/plots/parameter_to_time_box_plot.h>

Inheritance diagram for stat_bench::plots::ParameterToTimeBoxPlot:

Collaboration diagram for stat_bench::plots::ParameterToTimeBoxPlot:

Public Member Functions
	ParameterToTimeBoxPlot (const ParameterToTimeBoxPlot &)=delete
	ParameterToTimeBoxPlot (param::ParameterName parameter_name, PlotOptions options)
	Constructor.
	ParameterToTimeBoxPlot (ParameterToTimeBoxPlot &&)=delete
	~ParameterToTimeBoxPlot () override=default
	Destructor.
auto	name_for_file () const -> const util::Utf8String &override
	Get a name for output files.
auto	operator= (const ParameterToTimeBoxPlot &) -> ParameterToTimeBoxPlot &=delete
auto	operator= (ParameterToTimeBoxPlot &&) -> ParameterToTimeBoxPlot &=delete
void	write (const measurer::MeasurerName &measurer_name, const BenchmarkGroupName &group_name, const std::vector< measurer::Measurement > &measurements, const std::string &file_path) override
	Write a plot.
Public Member Functions inherited from stat_bench::plots::IPlot
	IPlot ()=default
	Constructor.
	IPlot (const IPlot &)=delete
	IPlot (IPlot &&)=delete
virtual	~IPlot ()=default
	Destructor.
auto	operator= (const IPlot &) -> IPlot &=delete
auto	operator= (IPlot &&) -> IPlot &=delete

Detailed Description

Class of box plots of measured times with respect to parameters.

Definition at line 35 of file parameter_to_time_box_plot.h.

Constructor & Destructor Documentation

ParameterToTimeBoxPlot()

stat_bench::plots::ParameterToTimeBoxPlot::ParameterToTimeBoxPlot	(	param::ParameterName	parameter_name,
		PlotOptions	options )

Constructor.

Parameters

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

Definition at line 41 of file parameter_to_time_box_plot.cpp.

Member Function Documentation

name_for_file()

auto stat_bench::plots::ParameterToTimeBoxPlot::name_for_file ( ) const -> const util::Utf8String&

nodiscardoverridevirtual

Get a name for output files.

Returns

Name.

Implements stat_bench::plots::IPlot.

Definition at line 47 of file parameter_to_time_box_plot.cpp.

write()

void stat_bench::plots::ParameterToTimeBoxPlot::write ( const measurer::MeasurerName & measurer_name, const BenchmarkGroupName & group_name, const std::vector< measurer::Measurement > & measurements, const std::string & file_path )

overridevirtual

Write a plot.

Parameters

[in]	measurer_name	Measurer name.
[in]	group_name	Group name.
[in]	measurements	Measurements.
[in]	file_path	File path of the output.

Implements stat_bench::plots::IPlot.

Definition at line 51 of file parameter_to_time_box_plot.cpp.

---

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

• include/stat_bench/plots/parameter_to_time_box_plot.h
• src/stat_bench/plots/parameter_to_time_box_plot.cpp