GlidingAverageMeasurement.h

Go to the documentation of this file.

// Copyright (C) 2009 Technische Universitaet Muenchen
// This file is part of the Peano project. For conditions of distribution and
// use, please see the copyright notice at www.peano-framework.org
#pragma once
 
 
#include <string>
#include <vector>
 
#include "tarch/logging/Log.h"
 
 
namespace tarch::timing {
  class GlidingAverageMeasurement;
} // namespace tarch::timing
 
 
class tarch::timing::GlidingAverageMeasurement {
  private:
    static tarch::logging::Log _log;
 
    const double _weight;
    const int    _maxEntries;
 
    std::vector<double> _values;
 
  public:
    static constexpr double DefaultWeight = 0.7;
 
    GlidingAverageMeasurement(double weight = DefaultWeight, int maxEntries = 16);
    ~GlidingAverageMeasurement() = default;
 
    double getValue() const;
 
    double getStandardDeviation() const;
 
    bool hasFullSetOfMeasurements() const;
 
    bool isAccurateValue(double factor = 0.1) const;
 
    void setValue(const double& value);
 
    std::string toString() const;
 
    double max() const;
    double min() const;
 
    void erase();
 
    int getObservationSpan() const;
};