ark::metrics::SummaryStats

Defined in header “ark/metrics/statistics.hh”.

Simple class to compute bastic statistics, which holds a vector of values.

Methods

  • SummaryStats()

  • void reset()
    Reset.

  • std::pair< T, Clock::time_point > max()
    return current max value

  • std::pair< T, Clock::time_point > min()
    return current min value

  • void update(const T & new_value, const Clock::time_point & time_point)
    Update with a new value.

  • double average()
    Calculate the average of the current values.

  • std::pair< T, Clock::time_point > percentile_value(const double & percentile)
    Calculate the percentile value for a given percentile input. Percentile input must be a value between 0.0 1.0.

  • size_t size()
    Returns the size of the underlying array.

  • bool empty()
    Returns true if this is empty or not. If empty, some APIs (such as percentile_value) will throw.

  • double standard_deviation()
    Calculate the standard deviation in the set (set must have more than 1 value)

  • double sample_variance()
    Calculate the sample variance the set by using the average (set must have more than 1 value)