contiguous_queue.h

Go to the documentation of this file.

/* Copyright (c) 2017 Skyward Experimental Rocketry
 * Author: Federico Terraneo
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#pragma once
 
#include <stdexcept>
 
namespace Boardcore
{
 
template <typename T, unsigned N>
class ContiguousQueue
{
public:
    ContiguousQueue() {}
 
    T* addEnd() { return elements + size; }
 
    T* removeEnd() { return elements; }
 
    const T* removeEnd() const { return elements; }
 
    unsigned int availableToAdd() const { return N - size; }
 
    unsigned int availableToRemove() const { return size; }
 
    void added(unsigned int n)
    {
        if (size + n > N)
            throw std::range_error("ContiguousBuffer::added");
        size += n;
    }
 
    void removed(unsigned int n)
    {
        if (n > size)
            throw std::range_error("ContiguousBuffer::removed");
        if (n == 0)
            return;
        for (unsigned int i = 0; i < size - n; i++)
            elements[i] = std::move(elements[i + n]);
        size -= n;
    }
 
private:
    ContiguousQueue(const ContiguousQueue&)            = delete;
    ContiguousQueue& operator=(const ContiguousQueue&) = delete;
 
    T elements[N]     = {0};
    unsigned int size = 0;
};
 
}  // namespace Boardcore