vt::runtime::component::DiagnosticErasedValue struct

Typed-erased, diagnostic values as strings for outputting to user after being formatted.

Public types

using UnionValueType = std::variant<double, int64_t, TimeType>

Public variables

UnionValueType min_
UnionValueType max_
min over all nodes
UnionValueType sum_
max over all nodes
double avg_
sum total over all nodes
double std_
mean over all nodes
DiagnosticUpdate update_
standard deviation over all nodes
DiagnosticUnit unit_
The value's unit type: Bytes, Seconds, Units, etc.
bool is_valid_value_
adt::HistogramApprox<double, int64_t> hist_

Typedef documentation

using vt::runtime::component::DiagnosticErasedValue::UnionValueType = std::variant<double, int64_t, TimeType>

These are the set of valid diagnostic value types after being erased from DiagnosticValue<T> get turned into this union for saving the value.

Variable documentation

DiagnosticUpdate vt::runtime::component::DiagnosticErasedValue::update_

standard deviation over all nodes

The updater type (SUM, MIN, MAX, REPLACE, AVG, etc.)

bool vt::runtime::component::DiagnosticErasedValue::is_valid_value_

Whether the value turned out to be valid (i.e., if a MIN updater ends up with the sentinel value std::numeric_limits<T>::min() after reduction, it was never updated and is_valid_value_ will be false)