【数据结构】设计环形队列

环形队列是一种线性数据结构，其操作表现基于 FIFO（先进先出）原则并且队尾被连接在队首之后以形成一个循环。它也被称为“环形缓冲器”。
环形队列的一个好处是我们可以利用这个队列之前用过的空间。在一个普通队列里，一旦一个队列满了，我们就不能插入下一个元素，即使在队列前面仍有空间。但是使用循环队列，我们能使用这些空间去存储新的值。

思路：
在环形队列中，队列为空时，队头队尾指向同一个位置。当队列不为空时，队头指向插入的第一个数据，队尾指向最后一个数据的下一个位置。当tail+1等于front时，说明环形队列已满。

注意：
环形队列的队尾不能像常规队列中队尾一样指向最后一个数据，如果这样的话，我们将不能区别环形队列的状态是空还是满，因为此时队头和队尾都指向同一个位置。这就意味着，我们必须留出一个空间，这个空间不能存放数据，这样我们才能很好的区别环形队列的状态是空还是满。

我们如果用一个数组来实现这个环形队列的话，上面这三种状态就对应于以下三种状态：

可以看出，此时这个数组和环形完全扯不上关系，这其实很简单，我们只需注意判断两个地方：
 1.当指针指向整个数组的后方的时候，让该指针重新指向数组的第一个元素。
 2.当指针指向整个数组的前方的时候，让该指针直接指向数组最后一个有效元素的后面。

这样就使得该数组在逻辑上是“环形”的了。

代码：

// 设计你的循环队列实现。 循环队列是一种线性数据结构，其操作表现基于 FIFO（先进先出）原则并且队尾被连接在队首之后以形成一个循环。它也被称为“环形缓冲器”。
#include <stdbool.h>
#include <stdlib.h>
// 循环队列的结构：使用数组来存储，队头，队尾的下标，一个存储数据的数组。K表示队列长度
typedef struct
{
    int *queue;
    int front;
    int rear;
    int k;
} MyCircularQueue;

MyCircularQueue *myCircularQueueCreate(int k) {
    // 数组大小要开辟k+1 预留一个空的空间，以方便判断空和满的两种情况
    MyCircularQueue *obj = (MyCircularQueue *) malloc(sizeof(MyCircularQueue));
    obj->queue = (int *) malloc(sizeof(int) * (k + 1));
    obj->front = 0;
    obj->rear = 0;
    obj->k = k;

    return obj;
}

// 队列判空front == rear
bool myCircularQueueIsEmpty(MyCircularQueue *obj) {
    assert(obj);
    // 判空的条件是front和rear都为0
    return obj->front == obj->rear;
}

// 队列判满 (rear+1)%(k+1)=front
bool myCircularQueueIsFull(MyCircularQueue *obj) {
    assert(obj);
    // 判满的条件是队列满了，rear指向了最后一个空的数组，+1需要回到front的位置，也就是(rear+1)%(k+1)==front
    return ((obj->rear + 1) % (obj->k + 1)) == obj->front;
}

//求有效长度(rear-front+k+1)%(k+1)
int myCircularQueueLength(MyCircularQueue *obj) {
    assert(obj);

    if (myCircularQueueIsEmpty(obj))
        return 0;

    return (obj->rear - obj->front + obj->k + 1) % (obj->k + 1);
}

bool myCircularQueueEnQueue(MyCircularQueue *obj, int value) {
    assert(obj);
    // 进队列  如果队列满了，就无法进队列，返回false
    if (myCircularQueueIsFull(obj))
        return false;

    obj->queue[obj->rear++] = value;
    // rear的值溢出，需要重新设置
    obj->rear %= (obj->k + 1);
    /* 也可以这么写
    if (obj->rear > obj->k)
        obj->rear = 0;
    */
    return true;
}

bool myCircularQueueDeQueue(MyCircularQueue *obj) {
    assert(obj);
    if (myCircularQueueIsEmpty(obj))
        return false;

    obj->front++;
    // front溢出重新设置
    obj->front %= (obj->k + 1);
    /* 也可以这么写
    if (obj->front > obj->k)
        obj->front = 0;
    */
    return true;
}

int myCircularQueueFront(MyCircularQueue *obj) {
    assert(obj);
    if (myCircularQueueIsEmpty(obj))
        return -1;

    return obj->queue[obj->front];
}

int myCircularQueueRear(MyCircularQueue *obj) {
    assert(obj);
    if (myCircularQueueIsEmpty(obj))
        return -1;

    // 如果rear == 0 说明rear在最后的位置  也就是k的位置
    if (obj->rear == 0)
        return obj->queue[obj->k];
    else
        return obj->queue[obj->rear - 1];
}

void myCircularQueueFree(MyCircularQueue *obj) {
    free(obj->queue);
    free(obj);
}