marvin_FixedCircularBuffer.h

Go to the documentation of this file.

// ========================================================================================================
//  _______ _______ ______ ___ ___ _______ _______
// |   |   |   _   |   __ \   |   |_     _|    |  |
// |       |       |      <   |   |_|   |_|       |
// |__|_|__|___|___|___|__|\_____/|_______|__|____|
//
// This file is part of the Marvin open source library and is licensed under the terms of the MIT License.
//
// ========================================================================================================
 
#include <marvin/library/marvin_Concepts.h>
#include <array>
namespace marvin::containers {
    template <FloatType T, size_t N>
    class FixedCircularBuffer final {
    public:
        FixedCircularBuffer() {
            reset();
        }

        void push(T toPush) {
            m_buffer[m_writeIndex++] = toPush;
            while (m_writeIndex >= static_cast<int>(N)) {
                m_writeIndex -= static_cast<int>(N);
            }
        }

        [[nodiscard]] T peek(size_t offset) const {
            auto actualIndex = (m_writeIndex - static_cast<int>(offset));
            while (actualIndex < 0) {
                actualIndex += static_cast<int>(N);
            }
            const auto res = m_buffer[static_cast<size_t>(actualIndex)];
            return res;
        }

        void reset() {
            std::fill(m_buffer.begin(), m_buffer.end(), static_cast<T>(0.0));
            m_writeIndex = 0;
        }
 
    private:
        std::array<T, N> m_buffer;
        int m_writeIndex{ 0 };
    };
} // namespace marvin::containers