stat_bench::measurer::Measurement Class Reference

Class of data of measurements. More...

#include <stat_bench/measurer/measurement.h>

Collaboration diagram for stat_bench::measurer::Measurement:

Public Member Functions
	Measurement (BenchmarkFullName case_info, BenchmarkCondition cond, MeasurerName measurer_name, std::size_t iterations, std::size_t samples, std::vector< std::vector< clock::Duration > > durations, std::vector< std::shared_ptr< stat::CustomStatOutput > > custom_stat_outputs, std::vector< std::pair< CustomOutputName, double > > custom_outputs)
	Constructor.
auto	case_info () const noexcept -> const BenchmarkFullName &
	Get the information of the case.
auto	cond () const noexcept -> const BenchmarkCondition &
	Get the condition.
auto	custom_outputs () const noexcept -> const std::vector< std::pair< CustomOutputName, double > > &
	Get the custom outputs without statistics.
auto	custom_stat () const noexcept -> const std::vector< stat::Statistics > &
	Get the statistics of custom outputs.
auto	custom_stat_outputs () const noexcept -> const std::vector< std::shared_ptr< stat::CustomStatOutput > > &
	Get the custom outputs with statistics.
auto	durations () const noexcept -> const std::vector< std::vector< clock::Duration > > &
	Get the measured durations.
auto	durations_stat () const noexcept -> const stat::Statistics &
	Get the statistics of durations.
auto	iterations () const noexcept -> const std::size_t &
	Get the number of iterations.
auto	measurer_name () const noexcept -> const MeasurerName &
	Get the name of the measurer.
auto	samples () const noexcept -> const std::size_t &
	Get the number of samples.

Detailed Description

Class of data of measurements.

Definition at line 42 of file measurement.h.

Constructor & Destructor Documentation

Measurement()

stat_bench::measurer::Measurement::Measurement ( BenchmarkFullName case_info, BenchmarkCondition cond, MeasurerName measurer_name, std::size_t iterations, std::size_t samples, std::vector< std::vector< clock::Duration > > durations, std::vector< std::shared_ptr< stat::CustomStatOutput > > custom_stat_outputs, std::vector< std::pair< CustomOutputName, double > > custom_outputs )

inline

Constructor.

Parameters

[in]	case_info	Information of the case.
[in]	cond	Condition.
[in]	measurer_name	Name of the measurer.
[in]	iterations	Number of iterations.
[in]	samples	Number of samples.
[in]	durations	Measured durations.
[in]	custom_stat_outputs	Custom outputs with statistics.
[in]	custom_outputs	Custom outputs without statistics.

Definition at line 56 of file measurement.h.

Member Function Documentation

case_info()

auto stat_bench::measurer::Measurement::case_info ( ) const -> const BenchmarkFullName&

inlinenodiscardnoexcept

Get the information of the case.

Returns

Information of the case.

Definition at line 83 of file measurement.h.

cond()

auto stat_bench::measurer::Measurement::cond ( ) const -> const BenchmarkCondition&

inlinenodiscardnoexcept

Get the condition.

Returns

Condition.

Definition at line 92 of file measurement.h.

custom_outputs()

auto stat_bench::measurer::Measurement::custom_outputs ( ) const -> const std::vector<std::pair<CustomOutputName, double>>&

inlinenodiscardnoexcept

Get the custom outputs without statistics.

Returns

Custom outputs without statistics.

Definition at line 170 of file measurement.h.

custom_stat()

auto stat_bench::measurer::Measurement::custom_stat ( ) const -> const std::vector<stat::Statistics>&

inlinenodiscardnoexcept

Get the statistics of custom outputs.

Returns

Statistics of custom outputs.

Definition at line 160 of file measurement.h.

custom_stat_outputs()

auto stat_bench::measurer::Measurement::custom_stat_outputs ( ) const -> const std::vector<std::shared_ptr<stat::CustomStatOutput>>&

inlinenodiscardnoexcept

Get the custom outputs with statistics.

Returns

Custom outputs with statistics.

Definition at line 150 of file measurement.h.

durations()

auto stat_bench::measurer::Measurement::durations ( ) const -> const std::vector<std::vector<clock::Duration>>&

inlinenodiscardnoexcept

Get the measured durations.

Note

Duration of iterations in each sample is measured per thread.

Returns

Measured durations.

Definition at line 130 of file measurement.h.

durations_stat()

auto stat_bench::measurer::Measurement::durations_stat ( ) const -> const stat::Statistics&

inlinenodiscardnoexcept

Get the statistics of durations.

Returns

Statistics of durations.

Definition at line 140 of file measurement.h.

iterations()

auto stat_bench::measurer::Measurement::iterations ( ) const -> const std::size_t&

inlinenodiscardnoexcept

Get the number of iterations.

Returns

Number of iterations.

Definition at line 110 of file measurement.h.

measurer_name()

auto stat_bench::measurer::Measurement::measurer_name ( ) const -> const MeasurerName&

inlinenodiscardnoexcept

Get the name of the measurer.

Returns

Name of the measurer.

Definition at line 101 of file measurement.h.

samples()

auto stat_bench::measurer::Measurement::samples ( ) const -> const std::size_t&

inlinenodiscardnoexcept

Get the number of samples.

Returns

Number of samples.

Definition at line 119 of file measurement.h.

---

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

• include/stat_bench/measurer/measurement.h