webrtc/rtc_base/numerics/sample_counter.h
Dor Hen 3723433d2f Add support for min value in SampleCounter
Required logic to query the min value of a SampleCounter along with some
additions to the existing test cases

Bug: webrtc:15580
Change-Id: I46afb30ad130f17f9e68ebc794b6935187bb2479
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/323900
Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org>
Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org>
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Cr-Commit-Position: refs/heads/main@{#40956}
2023-10-18 08:14:46 +00:00

60 lines
1.8 KiB
C++

/*
* Copyright (c) 2018 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#ifndef RTC_BASE_NUMERICS_SAMPLE_COUNTER_H_
#define RTC_BASE_NUMERICS_SAMPLE_COUNTER_H_
#include <stdint.h>
#include "absl/types/optional.h"
namespace rtc {
// Simple utility class for counting basic statistics (max./avg./variance) on
// stream of samples.
class SampleCounter {
public:
SampleCounter();
~SampleCounter();
void Add(int sample);
absl::optional<int> Avg(int64_t min_required_samples) const;
absl::optional<int> Max() const;
absl::optional<int> Min() const;
absl::optional<int64_t> Sum(int64_t min_required_samples) const;
int64_t NumSamples() const;
void Reset();
// Adds all the samples from the `other` SampleCounter as if they were all
// individually added using `Add(int)` method.
void Add(const SampleCounter& other);
protected:
int64_t sum_ = 0;
int64_t num_samples_ = 0;
absl::optional<int> max_;
absl::optional<int> min_;
};
class SampleCounterWithVariance : public SampleCounter {
public:
SampleCounterWithVariance();
~SampleCounterWithVariance();
void Add(int sample);
absl::optional<int64_t> Variance(int64_t min_required_samples) const;
void Reset();
// Adds all the samples from the `other` SampleCounter as if they were all
// individually added using `Add(int)` method.
void Add(const SampleCounterWithVariance& other);
private:
int64_t sum_squared_ = 0;
};
} // namespace rtc
#endif // RTC_BASE_NUMERICS_SAMPLE_COUNTER_H_