#include <src/vt/runtime/component/meter/stats_pack.h>
template<typename T>
vt::runtime::component::meter::DiagnosticStatsPack struct

Pack of statistic-based diagnostics intended to back diagnostic types where basic statistics should be applied.

Base classes

struct DiagnosticMeter

Derived classes

template<typename T>
struct Gauge
Diagnostic that records some value over time.
template<typename T>
struct Timer
Diagnostic that times some operation over time.

Constructors, destructors, conversion operators

DiagnosticStatsPack() defaulted
Default constructor so diagnostics meters can be in component classes and initialized later.
DiagnosticStatsPack(detail::DiagnosticValue<T>* in_sum, detail::DiagnosticValue<T>* in_avg, detail::DiagnosticValue<T>* in_max, detail::DiagnosticValue<T>* in_min)
Construct a new stats pack.

Public functions

void updateStats(T updated_val)
Update the underlying stats pack.
template<typename SerializerT>
void serialize(SerializerT& s)

Protected variables

detail::DiagnosticValue<T>* sum_
detail::DiagnosticValue<T>* avg_
detail::DiagnosticValue<T>* max_
detail::DiagnosticValue<T>* min_

Function documentation

template<typename T>
vt::runtime::component::meter::DiagnosticStatsPack<T>::DiagnosticStatsPack(detail::DiagnosticValue<T>* in_sum, detail::DiagnosticValue<T>* in_avg, detail::DiagnosticValue<T>* in_max, detail::DiagnosticValue<T>* in_min)

Construct a new stats pack.

Parameters
in_sum in the sum statistic
in_avg in the mean statistic
in_max in the max statistic
in_min in the min statistic

template<typename T>
void vt::runtime::component::meter::DiagnosticStatsPack<T>::updateStats(T updated_val)

Update the underlying stats pack.

Parameters
updated_val in the updated value

Variable documentation

template<typename T>
detail::DiagnosticValue<T>* vt::runtime::component::meter::DiagnosticStatsPack<T>::sum_ protected

Sum of all update values

template<typename T>
detail::DiagnosticValue<T>* vt::runtime::component::meter::DiagnosticStatsPack<T>::avg_ protected

Avg of all update values

template<typename T>
detail::DiagnosticValue<T>* vt::runtime::component::meter::DiagnosticStatsPack<T>::max_ protected

Max of all update values

template<typename T>
detail::DiagnosticValue<T>* vt::runtime::component::meter::DiagnosticStatsPack<T>::min_ protected

Min of all update values