1 Queue
1.1 定义
前面讲了Stack
是一种先进后出的数据结构:栈
,那么对应的Queue
是一种先进先出(First In First Out
)的数据结构:队列
对比一下Stack
,Queue
是一种先进先出的容器,它有两个口,从一个口放入元素,从另一个口获取元素。如果把栈比作一个木桶,那么队列就是一个管道。
队列有两个口,一个负责入队另一个负责出队,所以会有先进先出的效果。
当然我们说ArrayDeque
是一个双向队列,队列的两个口都可以入队和出队操作。再进一步说,其实ArrayDeque
可以说成是一个双向循环队列,是不是和链表的分类很像。
public class ArrayDeque<E> extends AbstractCollection<E>
implements Deque<E>, Cloneable, Serializable
从ArrayDeque
的定义可以看到,它继承AbstractCollection
,实现了Deque,Cloneable,Serializable
接口。Deque
接口在LinkedList
中见过,LinkedList
也是实现Deque
接口的。Deque
是一个双端队列,它实现于Queue
接口,那么什么是双端队列
,就是在队列的同一端即可以入队又可以出队,所以Deque
既可以作为队列又可以作为栈使用。但是今天这里是讲Queue
队列,所以就只看单向队列的一些原理和实现。
来看下Queue
接口:
public interface Queue<E> extends Collection<E> {
// 增加一个元素到队尾,如果队列已满,则抛出一个IIIegaISlabEepeplian异常
boolean add(E e);
// 添加一个元素到队尾并返回true,如果队列已满,则返回false
boolean offer(E e);
// 移除并返回队列头部的元素,如果队列为空,则抛出一个NoSuchElementException异常
E remove();
// 移除并返问队列头部的元素,如果队列为空,则返回null
E poll();
// 返回队列头部的元素,如果队列为空,则抛出一个NoSuchElementException异常
E element();
// 返问队列头部的元素,如果队列为空,则返回null
E peek();
}
看到Queue
的定义,发现它和Stack
的方法是非常相似的。
但是ArrayDeque
并不是一个固定大小的队列,每次队列满了就会进行扩容,除非扩容至超过int
的边界,才会抛出异常。所以这里的add
和offer
几乎是没有区别的。
1.2 底层存储
当然从ArrayDeque
的命名就可以看出底层是用数组实现的(而LinkedList
则是用链表实现的队列),来主要看一下ArrayDeque
// 底层用数组存储元素
private transient E[] elements;
// 队列的头部元素索引(即将pop出的一个)
private transient int head;
// 队列下一个要添加的元素索引
private transient int tail;
// 最小的初始化容量大小,需要为2的n次幂
private static final int MIN_INITIAL_CAPACITY = 8;
这里需要注意的是MIN_INITIAL_CAPACITY
,这个初始化容量必须为2的n次幂
。为什么必须要是2的n次幂呢,HashMap
要求其底层数组的初始容量必须为2的n次幂
。那么ArrayDeque
这里又是基于什么考虑呢,我们下面再看。tail
不是最后一个元素的索引,是下一个要添加的元素索引,也就是最后一个元素+1。
1.3 构造方法
/**
* 默认构造方法,数组的初始容量为16
*/
public ArrayDeque() {
elements = (E[]) new Object[16];
}
/** * 使用一个指定的初始容量构造一个ArrayDeque
*/
public ArrayDeque( int numElements) {
allocateElements(numElements);
}
/** * 构造一个指定Collection集合参数的ArrayDeque
*/
public ArrayDeque(Collection<? extends E> c) {
allocateElements(c.size());
addAll(c);
}
/**
* 分配合适容量大小的数组,确保初始容量是大于指定numElements的最小的2的n次幂
*/
private void allocateElements(int numElements) {
int initialCapacity = MIN_INITIAL_CAPACITY;
// 找到大于指定容量的最小的2的n次幂
// Find the best power of two to hold elements.
// Tests "<=" because arrays aren't kept full.
// 如果指定的容量小于初始容量8,则执行一下if中的逻辑操作
if (numElements >= initialCapacity) {
initialCapacity = numElements;
initialCapacity |= (initialCapacity >>> 1);
initialCapacity |= (initialCapacity >>> 2);
initialCapacity |= (initialCapacity >>> 4);
initialCapacity |= (initialCapacity >>> 8);
initialCapacity |= (initialCapacity >>> 16);
initialCapacity++;
if (initialCapacity < 0) // Too many elements, must back off
initialCapacity >>>= 1; // Good luck allocating 2 ^ 30 elements
}
elements = (E[]) new Object[initialCapacity];
}
我们来仔细分析一下,回想一下在HashMap
中分析过的,2的n次幂
和2的n次幂-1
的二进制是什么样子的呢,再来看一下:
2^n
转换为二进制是什么样子呢:
2^1 = 10
2^2 = 100
2^3 = 1000
2^n = 1(n个0)
再来看下2^n-1
的二进制是什么样子的:
2^1 - 1 = 01
2^2 - 1 = 011
2^3 - 1 = 0111
2^n - 1 = 0(n个1)
看下代码initialCapacity++
是什么意思呢,就是说initialCapity+1
之后才是2的n次幂
,那么此时的initialCapacity
是什么呢?就是上面的2^n - 1(initialCapacity + 1 = 2^n)
,也就是说怎么做到使initialCapacity
为2^n - 1
呢,那就上面的4次>>>
和|
操作了。>>>
是无符号右移,意思就是将一个操作数转换为二进制后,将后n
位移除,高位补0
。举个例子:11的二进制1101,11 >>> 2就是:(1)将后两位01移除,(2)高位补0,最后得0011。|
是按位或操作,意思是把两个操作数分别转换为二进制,如果两个操作数的位都有1则为1,全为0则为0,举个例子:两个数8和9的二进制分别为1000和1001,1000 | 1001 = 1001。
理解了>>>
和|
操作后,再来看下上面代码中的4个>>>
和|
是什么意思,>>>
将一个数低位变为1,|
后,最后整个数的二进制都变为1。
举个例子:如果initialCapacity=9,9转换为二进制为:1001,那么经过第一轮>>>1后为:100,然后1001 | 100 = 1101;经过第二轮>>>2后变为:0011,然后1101 | 0011 = 1111,1111转换为10进制+1后等于16(2^4),到此经过这一系列的操作就完成获取大于指定容量最小的2的n次幂。如果给定的initialCapacity够大的话,最终将变为1111111111111111111111111111111(31位1),当然最后为了防止溢出(initialCapacity<0),将initialCapacity右移1位变成2的30次方,那么什么时候initialCapacity
会小于0呢,那就是当initialCapacity
作为int值<<1越界后。
其实在HashMap
中也有这么一个目的的操作,只不过其代码不是这么实现的,它是通过一个循环,每次循环只右移1位。来回忆一下:
// 确保容量为2的n次幂,是capacity为大于initialCapacity的最小的2的n次幂
int capacity = 1;
while (capacity < initialCapacity)
capacity <<= 1;
那么这两种方法有什么区别呢?HashMap
中的这种写法更容量理解,而ArrayDeque
中的效果更高(最多经过4次位移和或操作+1次加一操作)。
1.4 入队(添加元素到队尾)
/** * 增加一个元素,如果队列已满,则抛出一个IIIegaISlabEepeplian异常
*/
public boolean add(E e) {
// 调用addLast方法,将元素添加到队尾
addLast(e);
return true;
}
/** * 添加一个元素
*/
public boolean offer(E e) {
// 调用offerLast方法,将元素添加到队尾
return offerLast(e);
}
/**
* 在队尾添加一个元素
*/ public boolean offerLast(E e) {
// 调用addLast方法,将元素添加到队尾
addLast(e);
return true;
}
/**
* 将元素添加到队尾
*/
public void addLast(E e) {
// 如果元素为null,咋抛出空指针异常
if (e == null)
throw new NullPointerException();
// 将元素e放到数组的tail位置
elements[tail ] = e;
// 判断tail和head是否相等,如果相等则对数组进行扩容
if ( (tail = (tail + 1) & ( elements.length - 1)) == head)
// 进行两倍扩容
doubleCapacity();
}
这里,( (tail = (tail + 1) & ( elements.length - 1)) == head)
这句代码是关键,为什么会这样写呢。正常的添加元素后应该是将tail+1
对不对,但是队列的删除和添加是不在同一端的,什么意思呢,我们画个图看一下。
我们假设队列的初始容量是8,初始队列添加了4个元素A、B、C、D,分别在数组0、1、2、3
的下标位置,如左图,此时的head
对应数组下标0,tail对应数组下标4。当队列经过一系列的入队和出队后,就会变成右图的样子,此时的head对应数组下标3,tail对应数组下标7 。那么问题来了,如果这个时候再增加一个元素到数组下标7的位置,此时理论上tail+1=8,也就是已经越界,需要对数组进行扩容了,但是我们看下数组0、1、2的位置由于出队操作,这三个位置是空的,如果此时就进行扩容会造成空间的浪费。
我们回想一下ArrayList
为了减少空间浪费,它是怎么做的呢,是通过数组copy
,每次删除元素都会将被删除元素索引后面位置的元素向前移动一位。但是这样做又造成了效率不高。怎么办呢,能不能换一种思路,我们可以把数组想象成为一个首尾相连的环
,数组的第一个位置索引0的位置和数组的最后一个位置索引length-1的位置是挨在一起的(双向链表)。
需要注意的是head
不是数组的第一个位置索引0
,tail
也不是数组的最后一个位置索引length-1
,head
和tail
实际上是一个指针,随着出队和入队操作不断的移动。如果tail
移动到length-1
之后,如果数组的第一个位置0
没有元素,那么需要将tail指向0
,依次向后指向。此时当tail
如果等于head
的时候会有两种情况,一个是空队列,另一个就是队列将要满了(只有tail处还有空位置),只要判断队列将要满了的时候,就进行数组扩容。
再来回忆下2的n次幂
和2的n次幂-1
转换成二进制后的样子:
2^n转换为二进制是什么样子呢:
2^1 = 10
2^2 = 100
2^3 = 1000
2^n = 1(n个0)
再来看下2^n-1的二进制是什么样子的:
2^1 - 1 = 01
2^2 - 1 = 011
2^3 - 1 = 0111
2^n - 1 = 0(n个1)
会发现什么,如果(2^n) & (2^n-1) = 0
对不对,举个例子,2^3=8
和2^3 - 1=7
,8和7的二进制分别为1000和0111,1000 & 0111 = 0000,也就是0嘛。
现在再来看这段代码( (tail = (tail + 1) & ( elements.length - 1)) == head)
是不是开始理解了,(tail + 1) & ( elements.length - 1)
,当tail
等于length-1
的时候也就是(2^n) & (2^n-1)
,此时将结果0赋值给tail,也就是这个时候tail指向了0,印证了前面我们的说法。那么如果tail
不是数组的最后一个位置的索引的时候呢,比如tail=5,那么5 & (elements.length - 1)实际上就等于5对不对,因为tail永远不会大于length的,所以当tail不等于length-1的时候,(tail + 1) & ( elements.length - 1)
的结果就是tail+1
(我们在HashMap中分析过h & (2^n - 1)
就相当于h % 2^n
)。
所以从这里看,我们就可以将ArrayDeque看做是一个双向循环队列,之所以这里用"看做"这个词,是因为这里只是代码逻辑上"环",而非存储结构上的"环"。
至此,我们终于明白( (tail = (tail + 1) & ( elements.length - 1)) == head)
这句代码的意义,我们再来总结下这句代码的效果:(1)将tail+1操作,(2)如果tail+1已经越界,则将tail赋值为0,(3)当tail和head指向同一个索引时,则说明需要进行扩容。既然是需要扩容,那么我们就来看看具体是怎么扩容的吧。
/** * 数组将要满了的时候(tail==head)将,数组进行2倍扩容
*/ private void doubleCapacity() {
// 验证head和tail是否相等
assert head == tail;
int p = head ;
// 记录数组的长度
int n = elements .length;
// 计算head后面的元素个数,这里没有采用jdk中自带的英文注释right,是因为所谓队列的上下左右,只是我们看的方位不同而已,如果上面画的图,这里就应该是left而非right
int r = n - p; // number of elements to the right of p
// 将数组长度扩大2倍
int newCapacity = n << 1;
// 如果此时长度小于0,则抛出IllegalStateException异常,什么时候newCapacity会小于0呢,前面我们说过了int值<<1越界
if (newCapacity < 0)
throw new IllegalStateException( "Sorry, deque too big" );
// 创建一个长度是原数组大小2倍的新数组
Object[] a = new Object[newCapacity];
// 将原数组head后的元素都拷贝值新数组
System. arraycopy(elements, p, a, 0, r);
// 将原数组head前的元素都拷贝到新数组
System. arraycopy(elements, 0, a, r, p);
// 将新数组赋值给elements
elements = (E[])a;
// 重置head为数组的第一个位置索引0
head = 0;
// 重置tail为数组的最后一个位置索引+1((length - 1) + 1)
tail = n;
}
这里需要清除,为什么要进行两次数组copy,因为数组被head
分成了两段。。。后面有元素,前面也有元素。。。
1.5 出队(移除并返回队头元素)
/** * 移除并返回队列头部的元素,如果队列为空,则抛出一个NoSuchElementException异常
*/
public E remove() {
// 调用removeFirst方法,移除队头的元素
return removeFirst();
}
/**
* @throws NoSuchElementException {@inheritDoc}
*/
public E removeFirst() {
// 调用pollFirst方法,移除并返回队头的元素
E x = pollFirst();
// 如果队列为空,则抛出NoSuchElementException异常
if (x == null)
throw new NoSuchElementException();
return x;
}
/**
* 移除并返问队列头部的元素,如果队列为空,则返回null
*/
public E poll() {
// 调用pollFirst方法,移除并返回队头的元素
return pollFirst();
}
public E pollFirst() {
int h = head ;
// 取出数组队头位置的元素
E result = elements[h]; // Element is null if deque empty
// 如果数组队头位置没有元素,则返回null值
if (result == null)
return null;
// 将数组队头位置置空,也就是删除元素
elements[h] = null; // Must null out slot
// 将head指针往前移动一个位置
head = (h + 1) & (elements .length - 1);
// 将队头元素返回
return result;
}
pollFirst
中的 (h + 1) & (elements . length - 1)
相比已经不用再具体解释了吧,不懂的看看上面的解释吧,当然这是为了处理临界的情况。
1.6 返回队头元素(不删除)
/** * 返回队列头部的元素,如果队列为空,则抛出一个NoSuchElementException异常
*/
public E element() {
// 调用getFirst方法,获取队头的元素
return getFirst();
}
/**
* @throws NoSuchElementException {@inheritDoc}
*/
public E getFirst() {
// 取得数组head位置的元素
E x = elements[head ];
// 如果数组head位置的元素为null,则抛出异常
if (x == null)
throw new NoSuchElementException();
return x;
}
/** * 返回队列头部的元素,如果队列为空,则返回null
*/ public E peek() {
// 调用peekFirst方法,获取队头的元素
return peekFirst();
}
public E peekFirst() {
// 取得数组head位置的元素并返回
return elements [head]; // elements[head] is null if deque empty
}
ArrayDeque
作为Queue
的操作方法,主要的难点则在于要把ArrayDeque
看成一个双向循环队列,head
和tail
指针是如何移动的,又是如果做到环
的,如果还不是很明白一定要对照图解多看几遍,并动手做一下位移和或操作。
当然ArrayDeque
作为一个双向队列还有一些Deque
特有的方法,以及作为Stack
的一些方法