moving_avg.hpp

Go to the documentation of this file.

/*
 *  SatNOGS-COMMS MCU software
 *
 *  Copyright (C) 2025, Libre Space Foundation <http://libre.space>
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  SPDX-License-Identifier: GNU General Public License v3.0 or later
 */
 
#pragma once
 
#include <etl/circular_buffer.h>
#include <type_traits>
 
namespace satnogs::comms::utils
{
 
template <typename OutputT, typename InputT, size_t SIZE> class moving_avg
{
private:
  OutputT                            m_sum{0};
  etl::circular_buffer<InputT, SIZE> m_circ;
 
public:
  moving_avg(InputT init = 0) : m_sum(0)
  {
    for (size_t i = 0; i < SIZE; i++) {
      m_circ.push(init);
      m_sum += init;
    }
  }
 
  void
  reset(InputT val)
  {
    for (size_t i = 0; i < SIZE; i++) {
      operator()(val);
    }
  }
 
  moving_avg &
  operator()(InputT sample)
  {
    m_sum += sample;
    m_sum -= m_circ.front();
    m_circ.push(sample);
    return *this;
  }
 
  OutputT
  operator()() const
  {
    return m_sum / OutputT{SIZE};
  }
};
 
} // namespace satnogs::comms::utils