环形缓冲区 Ring Buffer 的实现

环形缓冲区(Circular Buffer 或 Ring Buffer)是一种数据结构,它在逻辑上形成一个闭环。这种结构非常适用于需要固定大小的缓冲区的情况,如音频处理、网络通信、实时数据传输等。环形缓冲区的主要特点和用途包括:

固定大小:环形缓冲区的大小在创建时确定,并且在其生命周期内保持不变。

高效的数据插入和移除:在环形缓冲区中添加或移除元素(通常是在头部添加,在尾部移除)是非常高效的,因为这些操作不需要移动缓冲区中的其他元素。

循环覆盖:当缓冲区填满时,新添加的元素将覆盖最早添加的元素。这使得环形缓冲区非常适用于处理流式数据,其中只关心最近的数据。

无需动态内存分配:由于环形缓冲区的大小是固定的,因此在初始化后不需要额外的内存分配。

下面是C#中一个泛型环形缓冲区的实现

// LiteRingBuffer 是一个泛型类,用于存储类型为 T 的数据
public class LiteRingBuffer<T> : IEnumerable<T>
{

    // _elements 数组用于存储环形缓冲区的元素
    private readonly T[] _elements;

    // _start 和 _end 分别表示缓冲区中第一个和最后一个元素的索引
    private int _start;
    private int _end;

    // _count 表示缓冲区中当前元素的数量
    private int _count;

    // _capacity 表示缓冲区的最大容量
    private readonly int _capacity;
    
    // 索引器,用于访问缓冲区中的元素。它将索引 i 映射到环形缓冲区的正确位置
    public T this[int i] => _elements[(_start + i) % _capacity];

    // 构造函数,初始化环形缓冲区的大小
    public LiteRingBuffer(int count)
    {
        _elements = new T[count];
        _capacity = count;
    }

    // Add 方法用于向缓冲区添加新元素
    public void Add(T element)
    {
        if(_count == _capacity)
            throw new ArgumentException(); // 如果缓冲区已满,则抛出异常
        _elements[_end] = element; // 将元素添加到_end指向的位置
        _end = (_end + 1) % _capacity; // 更新_end索引
        _count++; // 增加元素数量
    }

    // FastClear 方法用于快速清空缓冲区
    public void FastClear()
    {
        _start = 0;
        _end = 0;
        _count = 0;
    }

    // Count 属性返回缓冲区中的元素数量
    public int Count => _count;

    // First 属性返回缓冲区中的第一个元素
    public T First => _elements[_start];

    // Last 属性返回缓冲区中的最后一个元素
    public T Last => _elements[(_start+_count-1)%_capacity];

    // IsFull 属性指示缓冲区是否已满
    public bool IsFull => _count == _capacity;

    // RemoveFromStart 方法从缓冲区的开始移除指定数量的元素
    public void RemoveFromStart(int count)
    {
        if(count > _capacity || count > _count)
            throw new ArgumentException(); // 如果请求移除的元素数量不合法,则抛出异常
        _start = (_start + count) % _capacity; // 更新_start索引
        _count -= count; // 减少元素数量
    }

    // GetEnumerator 方法提供了遍历缓冲区的方法
    public IEnumerator<T> GetEnumerator()
    {
        int counter = _start;
        while (counter != _end)
        {
            yield return _elements[counter];
            counter = (counter + 1) % _capacity;
        }           
    }

    // IEnumerable 接口的实现,用于集合的迭代
    IEnumerator IEnumerable.GetEnumerator()
    {
        return GetEnumerator();
    }
}