esp32-nmea2000-obp60/lib/obp60task/movingAvg.tpp

// Arduino Moving Average Library
// https://github.com/JChristensen/movingAvg
// Copyright (C) 2018 by Jack Christensen and licensed under
// GNU GPL v3.0, https://www.gnu.org/licenses/gpl.html

// Extended to template class for handling of multiple data types

// initialize - allocate the interval array
template <typename T>
void movingAvg<T>::begin()
{
    m_readings = new T[m_interval];
}

// add a new reading and return the new moving average
template <typename T>
T movingAvg<T>::reading(T newReading)
{
    // add each new data point to the sum until the m_readings array is filled
    if (m_nbrReadings < m_interval) {
        ++m_nbrReadings;
        m_sum += newReading;
    }
    // once the array is filled, subtract the oldest data point and add the new one
    else {
        m_sum = m_sum - m_readings[m_next] + newReading;
    }

    m_readings[m_next] = newReading;
    if (++m_next >= m_interval) m_next = 0;
    return getAvg();
}

// just return the current moving average
template <typename T>
T movingAvg<T>::getAvg()
{
    if (m_nbrReadings == 0) return 0;

    // Apply rounding for integers only
    if (std::is_floating_point<T>::value) {
        return m_sum / m_nbrReadings;
    } else {
        return (m_sum + (SumType)m_nbrReadings / 2) / m_nbrReadings;
    }
}

// return the average for a subset of the data, the most recent nPoints readings.
// for invalid values of nPoints, return zero.
template <typename T>
T movingAvg<T>::getAvg(int nPoints)
{
    if (nPoints < 1 || nPoints > m_interval || nPoints > m_nbrReadings) {
        return 0;
    }

    SumType sum{0};
    int i = m_next;
    for (int n=0; n<nPoints; ++n) {
        if (i == 0) {
            i = m_interval - 1;
        }
        else {
            --i;
        }
        sum += m_readings[i];
    }

    if (std::is_floating_point<T>::value) {
        return sum / nPoints;
    } else {
        return (sum + (SumType)nPoints / 2) / nPoints; //
    }
}

// start the moving average over again
template <typename T>
void movingAvg<T>::reset()
{
    m_nbrReadings = 0;
    m_sum = 0;
    m_next = 0;
}
// --- End Class movingAvg ---------------

// --- Class MovingAvgAngle ---------------
template <typename T>
void movingAvgAngle<T>::begin()
{
    m_buffer = new T[m_interval];
}

// add a new reading and return the new moving average
template <typename T>
T movingAvgAngle<T>::reading(T newReading)
{
    double s = std::sin(newReading);
    double c = std::cos(newReading);

    // add each new data point to the sum until the m_readings array is filled
    if (m_nbrReadings < m_interval) {
        ++m_nbrReadings;
        m_sumSin += s;
        m_sumCos += c;

    } else {
        // array is filled; subtract the oldest data point and add the new one
        m_sumSin = m_sumSin - sin(m_buffer[m_next]) + s;
        m_sumCos = m_sumCos - cos(m_buffer[m_next]) + c;
    }
    m_buffer[m_next] = newReading;

    if (++m_next >= m_interval)
        m_next = 0;

    return getAvg();
}

// return the current moving average
template <typename T>
T movingAvgAngle<T>::getAvg()
{
    if (m_nbrReadings == 0)
        return 0;

    // check size of vector; if near 0, set it to 0
    const double len = m_sumSin * m_sumSin + m_sumCos * m_sumCos;
    if (len < 1e-24)
        return 0.0;   // average direction undefined  

    return static_cast<T>(to2PI(std::atan2(m_sumSin, m_sumCos)));
}

// return the current moving average for a subset of the data, the most recent nPoints readings.
// for invalid values of nPoints, return zero.
template <typename T>
T movingAvgAngle<T>::getAvg(int nPoints)
{
    if (nPoints < 1 || nPoints > m_interval || nPoints > m_nbrReadings)
        return 0;

    double sumSin = 0.0;
    double sumCos = 0.0;

    int i = m_next;
    for (int n = 0; n < nPoints; ++n) {
        if (i == 0)
            i = m_interval - 1;
        else
            --i;

        sumSin += std::sin(m_buffer[i]);
        sumCos += std::cos(m_buffer[i]);
    }

    // check size of vector; if near 0, set it to 0
    const double len = m_sumSin * m_sumSin + m_sumCos * m_sumCos;
    if (len < 1e-24)
        return 0.0;   // average direction undefined  

    return static_cast<T>(to2PI(std::atan2(sumSin, sumCos)));
}

// start the moving average over again
template <typename T>
void movingAvgAngle<T>::reset()
{
    m_nbrReadings = 0;
    m_sumSin = 0;
    m_sumCos = 0;
    m_next = 0;
}

template <typename T>
T movingAvgAngle<T>::to2PI(T a)
{
    a = fmod(a, M_TWOPI);
    if (a < 0.0) {
        a += M_TWOPI;
    }
    return a;
}
// --- End class MovingAvgAngle ---------------