stat_bench::stat::Statistics Class Reference

Class to calculate statistics. More...

#include <stat_bench/stat/statistics.h>

Collaboration diagram for stat_bench::stat::Statistics:

Public Member Functions
	Statistics (std::vector< double > unsorted_samples, std::vector< double > sorted_samples, double mean, double max, double min, double median, double variance, double standard_deviation, double standard_error)
	Constructor.
auto	max () const noexcept -> double
	Get the max.
auto	mean () const noexcept -> double
	Get the mean.
auto	median () const noexcept -> double
	Get the median.
auto	min () const noexcept -> double
	Get the min.
auto	sorted_samples () const noexcept -> const std::vector< double > &
	Get the sorted samples.
auto	standard_deviation () const noexcept -> double
	Get the standard deviation.
auto	standard_error () const noexcept -> double
	Get the standard error.
auto	unsorted_samples () const noexcept -> const std::vector< double > &
	Get the unsorted samples.
auto	variance () const noexcept -> double
	Get the variance.

Detailed Description

Class to calculate statistics.

Definition at line 31 of file statistics.h.

Constructor & Destructor Documentation

Statistics()

stat_bench::stat::Statistics::Statistics ( std::vector< double > unsorted_samples, std::vector< double > sorted_samples, double mean, double max, double min, double median, double variance, double standard_deviation, double standard_error )

inline

Constructor.

Parameters

[in]	unsorted_samples	Unsorted samples.
[in]	sorted_samples	Sorted samples.
[in]	mean	Mean.
[in]	max	Max.
[in]	min	Min.
[in]	median	Median.
[in]	variance	Variance.
[in]	standard_deviation	Standard deviation.
[in]	standard_error	Standard error.

Definition at line 46 of file statistics.h.

Member Function Documentation

max()

auto stat_bench::stat::Statistics::max ( ) const -> double

inlinenodiscardnoexcept

Get the max.

Returns

Max.

Definition at line 91 of file statistics.h.

mean()

auto stat_bench::stat::Statistics::mean ( ) const -> double

inlinenodiscardnoexcept

Get the mean.

Returns

Mean.

Definition at line 84 of file statistics.h.

median()

auto stat_bench::stat::Statistics::median ( ) const -> double

inlinenodiscardnoexcept

Get the median.

Returns

Median.

Definition at line 105 of file statistics.h.

min()

auto stat_bench::stat::Statistics::min ( ) const -> double

inlinenodiscardnoexcept

Get the min.

Returns

Min.

Definition at line 98 of file statistics.h.

sorted_samples()

auto stat_bench::stat::Statistics::sorted_samples ( ) const -> const std::vector<double>&

inlinenodiscardnoexcept

Get the sorted samples.

Returns

Sorted samples.

Definition at line 74 of file statistics.h.

standard_deviation()

auto stat_bench::stat::Statistics::standard_deviation ( ) const -> double

inlinenodiscardnoexcept

Get the standard deviation.

Returns

Standard deviation.

Definition at line 119 of file statistics.h.

standard_error()

auto stat_bench::stat::Statistics::standard_error ( ) const -> double

inlinenodiscardnoexcept

Get the standard error.

Returns

Standard error.

Definition at line 128 of file statistics.h.

unsorted_samples()

auto stat_bench::stat::Statistics::unsorted_samples ( ) const -> const std::vector<double>&

inlinenodiscardnoexcept

Get the unsorted samples.

Returns

Unsorted samples.

Definition at line 64 of file statistics.h.

variance()

auto stat_bench::stat::Statistics::variance ( ) const -> double

inlinenodiscardnoexcept

Get the variance.

Returns

Variance.

Definition at line 112 of file statistics.h.

---

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

• include/stat_bench/stat/statistics.h