ModuloCircularBuffer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/ContainerAllocationPolicies.h"
 
namespace UE::TimeManagement
{
template<typename T, typename TAllocator = FDefaultAllocator>
class TModuloCircularBuffer
{
public:
    
    explicit TModuloCircularBuffer(SIZE_T InNumSamples) { Data.SetNumUninitialized(InNumSamples); }
 
    void Add(const T& InItem)
    {
        Data[NextIndexToInsert] = InItem;
        bIsBufferFull |= NextIndexToInsert == Data.Num() - 1;
        NextIndexToInsert = (NextIndexToInsert + 1) % Data.Num();
    }
 
    const T* GetNextReplacedItem() const
    {
        return bIsBufferFull ? &Data[NextIndexToInsert] : nullptr;
    }
 
    SIZE_T Capacity() const 
    {
        return Data.Num();
    }
    
    SIZE_T Num() const 
    {
        return bIsBufferFull ? Capacity() : NextIndexToInsert; 
    }
    bool IsEmpty() const 
    { 
        return !bIsBufferFull && NextIndexToInsert == 0;
    }
    
    bool IsFull() const 
    { 
        return bIsBufferFull; 
    }
 
    TConstArrayView<T> AsUnorderedView() const
    {
        return bIsBufferFull ? TConstArrayView<T>(Data.GetData(), Data.Num()) : TConstArrayView<T>(Data.GetData(), NextIndexToInsert);
    }
 
private:
 
    TArray<T, TAllocator> Data;
 
    bool bIsBufferFull = false;
    SIZE_T NextIndexToInsert = 0;
};
}