movingAvg.h

Go to the documentation of this file.

 
#ifndef MOVINGAVG_H
#define MOVINGAVG_H
 
#include <Arduino.h>
 
#include "type_traits.hpp"
 
template< typename T, uint8_t DURATION_IN_MINUTES = 10, uint8_t VALUES_PER_MINUTE = 10 >
class movingAvg
{
public:
  void clear()
  {
    _idx = 0;
 
    if constexpr (is_floating_point< T >::value)
    {
      _sum = 0.0F;
    }
    else
    {
      _sum = 0;
    }
 
    uint8_t i{ DURATION_IN_MINUTES };
    do {
      --i;
      if constexpr (is_floating_point< T >::value)
      {
        _ar[i] = 0.0F;
      }
      else
      {
        _ar[i] = 0;
      }
    } while (i);
 
    _clear_sub();
  }
 
  void addValue(const T& _value)
  {
    _sub_sum -= _sub_ar[_sub_idx];
    _sub_ar[_sub_idx] = _value;
    _sub_sum += _value;
    ++_sub_idx;
 
    if (_sub_idx == VALUES_PER_MINUTE)
    {
      _sub_idx = 0;  // faster than %
      _addValue(_getAverage());
    }
  }
 
  void fillValue(const T& _value)
  {
    _idx = 0;
    _sum = DURATION_IN_MINUTES * _value;
 
    uint8_t i{ DURATION_IN_MINUTES };
    do
    {
      _ar[--i] = _value;
    } while (i);
  }
 
  auto getAverage() const
  {
    if constexpr (DURATION_IN_MINUTES == 1)
      return _getAverage();
    else if constexpr (DURATION_IN_MINUTES == 2)
      return _sum >> 1;
    else if constexpr (DURATION_IN_MINUTES == 4)
      return _sum >> 2;
    else if constexpr (DURATION_IN_MINUTES == 8)
      return _sum >> 3;
    else if constexpr (DURATION_IN_MINUTES == 16)
      return _sum >> 4;
    else if constexpr (DURATION_IN_MINUTES == 32)
      return _sum >> 5;
    else
      return _sum * invN;
  }
 
  auto getElement(uint8_t idx) const
  {
    if (idx >= DURATION_IN_MINUTES)
    {
      if constexpr (is_floating_point< T >::value)
        return 0.0F;
      else
        return (T)0;
    }
 
    return _ar[idx];
  }
 
  [[nodiscard]] constexpr uint8_t getSize() const
  {
    return DURATION_IN_MINUTES;
  }
 
private:
  void _clear_sub()
  {
    _sub_idx = 0;
 
    if constexpr (is_floating_point< T >::value)
      _sub_sum = 0.0F;
    else
      _sub_sum = 0;
 
    uint8_t i{ VALUES_PER_MINUTE };
    do {
      --i;
      if constexpr (is_floating_point< T >::value)
        _sub_ar[i] = 0.0F;
      else
        _sub_ar[i] = 0;
    } while (i);
  }
 
  void _addValue(const T& _value)
  {
    _sum -= _ar[_idx];
    _ar[_idx] = _value;
    _sum += _value;
    ++_idx;
 
    if (_idx == DURATION_IN_MINUTES)
    {
      _idx = 0;  // faster than %
    }
  }
 
  auto _getAverage() const
  {
    return _sub_sum * invD;
  }
 
private:
  uint8_t _idx{ 0 };
  uint8_t _sub_idx{ 0 };
  typename conditional< is_floating_point< T >::value, T, int32_t >::type _sum{ 0 };
  typename conditional< is_floating_point< T >::value, T, int32_t >::type _sub_sum{ 0 };
 
  T _sub_ar[VALUES_PER_MINUTE]{};
  T _ar[DURATION_IN_MINUTES]{};
 
  static constexpr float invD{ 1.0 / VALUES_PER_MINUTE };
  static constexpr float invN{ 1.0 / DURATION_IN_MINUTES };
};
 
#endif