RingQueue.h

浏览该文件的文档.

// Copyright 2024 libsese
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
 
#pragma once
 
#include <stdexcept>
 
namespace sese {
 
template<typename T, int N>
class RingQueue {
public:
    // 获取队头元素，元素不足则抛出异常
    T &front() {
        if (empty()) {
            throw std::out_of_range("queue is empty");
        }
        return _data[_head];
    }
 
    // 出队，元素不足则抛出异常
    void pop() {
        if (empty()) {
            throw std::out_of_range("queue is empty");
        }
        _head = (_head + 1) % N;
        _size -= 1;
    }
 
    // 入队，队列已满则抛出异常
    void push(const T &data) {
        if (full()) {
            throw std::out_of_range("queue is full");
        }
        _data[_tail] = data;
        _tail = (_tail + 1) % N;
        _size += 1;
    }
 
    // 判断队列是否为空
    [[nodiscard]] bool empty() const {
        return _size == 0;
    }
 
    // 判断队列是否已满
    [[nodiscard]] bool full() const {
        return _size == N;
    }
 
    // 获取队列大小
    [[nodiscard]] size_t size() const {
        return _size;
    }
 
private:
    T _data[N];
    size_t _head{};
    size_t _tail{};
    size_t _size{};
};
} // namespace sese