环形队列的实现 [详解在代码中]

package DataStructures.Queue.Array.Exerice;

/**
 * @author Loe.
 * @project DataStructures&Algorithms
 * @date 2023/5/8
 * @ClassInfo 环形队列
 *            主要使用取模的特性来实现环形特征
 */
public class CirularQueue {
    //当前队列大小
    public int maxSize;
    //队列
    public int[] queue;
    //指向第一个元素
    public int front;
    //指向最后一个元素的再后一个元素
    public int rear;

    public CirularQueue(int maxSize) {
        this.maxSize = maxSize;
        //创建队列数组
        this.queue = new int[maxSize];
        //初始化指针
        this.front = 0;
        this.rear = 0;
    }

    public void addQueue(int data){
        if (this.isFull()){
            System.out.println("队列已满~");

        }else{
            //因为real指向的最后一个元素的后一个元素
            //所以这里可以直接使用并赋值
            //初始化为0可以理解为:
            //- 初始化时,最后一个元素的索引是 -1
            this.queue[this.rear] = data;

            //解决环形队列问题
            //在以往我们需要将rear++
            //并且保证rear是小于maxSize即可
            //但环形队列需要用一种方法来把 rear 困在 maxSize中
            //使其从始至终都无法超过maxSize
            //所以我们使用 "取模运算" 来实现
            this.rear = (rear + 1) % maxSize;
        }
    }

    /**
     * 取出元素方法
     * 在这个方法中我们需要解决 front索引指向的位置问题
     * 同 add 一样,我们也需要将front困在maxSize中
     */
    public int getData(){
        //如果为空
        if (isEmpty()){
            System.out.println("无法取出,队列为空~");
        }
        //由于我们需要对front进行操作
        //所以将front先前指向的值取出,存到一个临时变量中
        int upData = this.queue[this.front];

        //接下来对front进行操作
        this.front = (this.front + 1) % this.maxSize;

        return upData;
    }


    //展示队列
    public void show(){
        for (int i = this.front; i < front + size(); i++) {
            System.out.printf("队列元素索引[%d]=%d\n",i % this.maxSize,this.queue[i % this.maxSize]);
        }
    }


    //判断是否为空
    public boolean isFull(){
        //队列满的条件是什么?
        //以往: rear == maxSize
        //为适配环形队列,条件改为:
        //(rear + 1) % maxSize == front
        return (this.rear + 1) % maxSize == front;
    }

    public boolean isEmpty(){
        return this.rear == this.front;
    }

    //获取当前队列可用的元素数量
    public int size(){
        return (rear + maxSize - front) % maxSize;
    }



    public int getMaxSize() {
        return maxSize;
    }

    public void setMaxSize(int maxSize) {
        this.maxSize = maxSize;
    }

    public int[] getQueue() {
        return queue;
    }

    public void setQueue(int[] queue) {
        this.queue = queue;
    }

    public int getFront() {
        return front;
    }

    public void setFront(int front) {
        this.front = front;
    }

    public int getRear() {
        return rear;
    }

    public void setRear(int rear) {
        this.rear = rear;
    }
}