Struct astrea::trace::HyperStats

template <class T>

ClassList > astrea > trace > HyperStats

The HyperStats struct represents statistics of statistics, allowing for the calculation of statistics on a vector of Stats<T>.More...

• #include <HyperStats.hpp>

Public Attributes

Type	Name
Stats< T >	avg Statistics for the average values across the input Stats<T> vector.
Stats< T >	max Statistics for the maximum values across the input Stats<T> vector.
Stats< T >	min Statistics for the minimum values across the input Stats<T> vector.
std::vector< Stats< T > >	percentiles Statistics for each percentile across the input Stats<T> vector.

Public Functions

Type	Name
	HyperStats () = default Default constructor for HyperStats .
	HyperStats (const std::vector< Stats< T >> & statsVec) Constructs a HyperStats object from a vector of Stats<T>.
std::vector< std::string >	to_string_vector () const Converts the statistics of statistics to a vector of strings for output.

Public Static Functions

Type	Name
constexpr std::size_t	size ()

Detailed Description

It contains Stats<T> for the minimum, maximum, and average values across the input Stats<T> vector, as well as a vector of Stats<T> for each percentile.

Public Attributes Documentation

variable avg

Statistics for the average values across the input Stats<T> vector.

Stats<T> astrea::trace::HyperStats< T >::avg;

---

variable max

Statistics for the maximum values across the input Stats<T> vector.

Stats<T> astrea::trace::HyperStats< T >::max;

---

variable min

Statistics for the minimum values across the input Stats<T> vector.

Stats<T> astrea::trace::HyperStats< T >::min;

---

variable percentiles

Statistics for each percentile across the input Stats<T> vector.

std::vector<Stats<T> > astrea::trace::HyperStats< T >::percentiles;

---

Public Functions Documentation

function HyperStats [1/2]

Default constructor for HyperStats .

astrea::trace::HyperStats::HyperStats () = default

---

function HyperStats [2/2]

Constructs a HyperStats object from a vector of Stats<T>.

inline astrea::trace::HyperStats::HyperStats (
    const std::vector< Stats < T >> & statsVec
) 

Parameters:

• statsVec A vector of Stats<T> to calculate the statistics of.

Exception:

• std::runtime_error If the input vector is empty.

---

function to_string_vector

Converts the statistics of statistics to a vector of strings for output.

inline std::vector< std::string > astrea::trace::HyperStats::to_string_vector () const

Returns:

std::vector<std::string> A vector of strings representing the statistics of statistics.

---

Public Static Functions Documentation

function size

static inline constexpr std::size_t astrea::trace::HyperStats::size () 

---

---

The documentation for this class was generated from the following file astrea/trace/trace/analysis/stats/HyperStats.hpp