环境和版本

Mac M1
IDEA 2021
Zulu Open JDK

简介
上篇以Java ArrayDeque为例讲解了Stack和Queue，其实还有一种特殊的队列叫做PriorityQueue，即优先队列。优先队列的作用是能保证每次取出的元素都是队列中权值最小的(Java的优先队列每次取最小元素，C++的优先队列每次取最大元素)。这里牵涉到了大小关系，元素大小的评判可以通过元素本身的自然顺序(natural ordering)，也可以通过构造时传入的比较器(Comparator，类似于C++的仿函数)。 Java中PriorityQueue实现了Queue接口，不允许放入null元素；其通过堆实现，具体说是通过完全二叉树(complete binary tree)实现的小顶堆(任意一个非叶子节点的权值，都不大于其左右子节点的权值)，也就意味着可以通过数组来作为PriorityQueue的底层实现。

上图中我们给每个元素按照层序遍历的方式进行了编号，如果你足够细心，会发现父节点和子节点的编号是有联系的，更确切的说父子节点的编号之间有如下关系
- leftNo = parentNo*2+1
- rightNo = parentNo*2+2
- parentNo = (nodeNo-1)/2
通过上述三个公式，可以轻易计算出某个节点的父节点以及子节点的下标。这也就是为什么可以直接用数组来存储堆的原因
类图

构造函数
```java private static final int DEFAULT_INITIAL_CAPACITY = 11;

// 无参构造函数 public PriorityQueue() { this(DEFAULT_INITIAL_CAPACITY, null); }

// 初始化大小 public PriorityQueue(int initialCapacity) { this(initialCapacity, null); }

// 比较器 public PriorityQueue(Comparator<? super E> comparator) { this(DEFAULT_INITIAL_CAPACITY, comparator); }

// 初始化大小 // 比较器 public PriorityQueue(int initialCapacity, Comparator<? super E> comparator) { // Note: This restriction of at least one is not actually needed, // but continues for 1.5 compatibility if (initialCapacity < 1) throw new IllegalArgumentException(); this.queue = new Object[initialCapacity]; this.comparator = comparator; }

// 传入集合 public PriorityQueue(Collection<? extends E> c) { // 如果是 SortedSet if (c instanceof SortedSet<?>) { SortedSet<? extends E> ss = (SortedSet<? extends E>) c; this.comparator = (Comparator<? super E>) ss.comparator(); initElementsFromCollection(ss); } // 如果是 PriorityQueue else if (c instanceof PriorityQueue<?>) { PriorityQueue<? extends E> pq = (PriorityQueue<? extends E>) c; this.comparator = (Comparator<? super E>) pq.comparator(); initFromPriorityQueue(pq); } else { // 否则，不设置比较器 this.comparator = null; initFromCollection(c); } }

// PriorityQueue 类型 public PriorityQueue(PriorityQueue<? extends E> c) { this.comparator = (Comparator<? super E>) c.comparator(); initFromPriorityQueue(c); }

// SortedSet类型 public PriorityQueue(SortedSet<? extends E> c) { this.comparator = (Comparator<? super E>) c.comparator(); initElementsFromCollection(c); }

// initElementsFromCollection private void initElementsFromCollection(Collection<? extends E> c) { // 获取数组 Object[] a = c.toArray(); if (c.getClass() != ArrayList.class) // 不为 ArrayList 类型，直接拷贝 a = Arrays.copyOf(a, a.length, Object[].class); int len = a.length; if (len == 1 || this.comparator != null) for (int i = 0; i < len; i++) if (a[i] == null) throw new NullPointerException(); this.queue = a; this.size = a.length; }

// 从 PriorityQueue 初始化 private void initFromPriorityQueue(PriorityQueue<? extends E> c) { if (c.getClass() == PriorityQueue.class) { this.queue = c.toArray(); this.size = c.size(); } else { initFromCollection(c); } }

// 从 Collection 初始化 private void initFromCollection(Collection<? extends E> c) { // 从集合初始化元素 initElementsFromCollection(c); // 在树中建立堆不变量，在调用之前不考虑元素的顺序 // 调整成小根堆或者大根堆 heapify(); }

// 在树中建立堆不变量，在调用之前不考虑元素的顺序 private void heapify() { // 取一半，这里是小的一半 // 然后在 siftDown 里面和另外一半进行比较，找到最小的 for (int i = (size >>> 1) - 1; i >= 0; i—) siftDown(i, (E) queue[i]); }

// k 下标 // x 元素 private void siftDown(int k, E x) { if (comparator != null) // 比较器不为null siftDownUsingComparator(k, x); else // 比较器为null siftDownComparable(k, x); }

private void siftDownComparable(int k, E x) { // 当前元素 Comparable<? super E> key = (Comparable<? super E>)x; // 折半 half 是中间值 int half = size >>> 1; // loop while a non-leaf // k 是 while (k < half) { // 首先找到左右孩子中较小的那个，记录到c里，并用child记录其下标 // leftNo = parentNo*2+1 int child = (k << 1) + 1; // assume left child is least Object c = queue[child]; // 右节点 int right = child + 1; if (right < size && ((Comparable<? super E>) c).compareTo((E) queue[right]) > 0) c = queue[child = right]; if (key.compareTo((E) c) <= 0) break; // 用c取代原来的值 queue[k] = c; k = child; } queue[k] = key; }

@SuppressWarnings(“unchecked”) private void siftDownUsingComparator(int k, E x) { int half = size >>> 1; while (k < half) { int child = (k << 1) + 1; Object c = queue[child]; int right = child + 1; if (right < size && comparator.compare((E) c, (E) queue[right]) > 0) c = queue[child = right]; if (comparator.compare(x, (E) c) <= 0) break; queue[k] = c; k = child; } queue[k] = x; }

<a name="T4KEO"></a>
# add()和offer()
- add(E e)和offer(E e)的语义相同，都是向优先队列中插入元素，只是Queue接口规定二者对插入失败时的处理不同，前者在插入失败时抛出异常，后则则会返回false。对于PriorityQueue这两个方法其实没什么差别
![image.png](https://cdn.nlark.com/yuque/0/2022/png/1806904/1644743318739-250a40f6-3842-4f50-9e3a-689ad9f9c97b.png#clientId=uc1eb4807-7ecb-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=589&id=u69e97d05&margin=%5Bobject%20Object%5D&name=image.png&originHeight=1177&originWidth=1400&originalType=binary&ratio=1&rotation=0&showTitle=false&size=166114&status=done&style=none&taskId=u77b5bf38-36ee-4726-819a-5176ab8feaf&title=&width=700)
- 新加入的元素可能会破坏小顶堆的性质，因此需要进行必要的调整
```java
public boolean add(E e) {
    return offer(e);
}
public boolean offer(E e) {
    if (e == null)
        throw new NullPointerException();
    modCount++;
    int i = size;
    if (i >= queue.length)
        // 扩容
        grow(i + 1);
    size = i + 1;
    if (i == 0)
        // 原本队列为空，这是插入的第一个元素
        queue[0] = e;
    else
        // 调整
        siftUp(i, e);
    return true;
}

上述代码中，扩容函数grow()类似于ArrayList里的grow()函数，就是再申请一个更大的数组，并将原数组的元素复制过去，这里不再赘述。需要注意的是siftUp(int k, E x)方法，该方法用于插入元素x并维持堆的特性。 ```java private void siftUp(int k, E x) { if (comparator != null)
```
  siftUpUsingComparator(k, x);
```
else
```
  siftUpComparable(k, x);
```
}

@SuppressWarnings(“unchecked”) private void siftUpComparable(int k, E x) { Comparable<? super E> key = (Comparable<? super E>) x; while (k > 0) { int parent = (k - 1) >>> 1; Object e = queue[parent]; if (key.compareTo((E) e) >= 0) break; queue[k] = e; k = parent; } queue[k] = key; }

@SuppressWarnings(“unchecked”) private void siftUpUsingComparator(int k, E x) { while (k > 0) { // parentNo = (nodeNo-1)/2 int parent = (k - 1) >>> 1; Object e = queue[parent]; if (comparator.compare(x, (E) e) >= 0) break; queue[k] = e; k = parent; } queue[k] = x; }


- 新加入的元素x可能会破坏小顶堆的性质，因此需要进行调整。调整的过程为：**从k指定的位置开始，将x逐层与当前点的parent进行比较并交换，直到满足x >= queue[parent]为止**。注意这里的比较可以是元素的自然顺序，也可以是依靠比较器的顺序
<a name="ZYptI"></a>
# element()和peek()

- element()和peek()的语义完全相同，都是获取但不删除队首元素，也就是队列中权值最小的那个元素，二者唯一的区别是当方法失败时前者抛出异常，后者返回null。根据小顶堆的性质，堆顶那个元素就是全局最小的那个；由于堆用数组表示，根据下标关系，0下标处的那个元素既是堆顶元素。所以直接返回数组0下标处的那个元素即可

![image.png](https://cdn.nlark.com/yuque/0/2022/png/1806904/1644743610963-fa5fe801-5dc1-4b15-ad91-0bf3d135047d.png#clientId=uc1eb4807-7ecb-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=336&id=u58a631a7&margin=%5Bobject%20Object%5D&name=image.png&originHeight=672&originWidth=800&originalType=binary&ratio=1&rotation=0&showTitle=false&size=53714&status=done&style=none&taskId=uc0e0e85e-c43e-4e11-86e8-569fb8ffd5d&title=&width=400)
```java
public E peek() {
    return (size == 0) ? null : (E) queue[0];
}

remove()和poll()

remove()和poll()方法的语义也完全相同，都是获取并删除队首元素，区别是当方法失败时前者抛出异常，后者返回null。由于删除操作会改变队列的结构，为维护小顶堆的性质，需要进行必要的调整

public E poll() {
    if (size == 0)
        return null;
    int s = --size;
    modCount++;
    E result = (E) queue[0];
    E x = (E) queue[s];
    queue[s] = null;
    if (s != 0)
        siftDown(0, x);
    return result;
}

上述代码首先记录0下标处的元素，并用最后一个元素替换0下标位置的元素，之后调用siftDown()方法对堆进行调整，最后返回原来0下标处的那个元素(也就是最小的那个元素)。重点是siftDown(int k, E x)方法，该方法的作用是从k指定的位置开始，将x逐层向下与当前点的左右孩子中较小的那个交换，直到x小于或等于左右孩子中的任何一个为止

remove(Object o)
remove(Object o)方法用于删除队列中跟o相等的某一个元素(如果有多个相等，只删除一个)，该方法不是Queue接口内的方法，而是Collection接口的方法。由于删除操作会改变队列结构，所以要进行调整；又由于删除元素的位置可能是任意的，所以调整过程比其它函数稍加繁琐。具体来说，remove(Object o)可以分为2种情况: 1. 删除的是最后一个元素。直接删除即可，不需要调整。2. 删除的不是最后一个元素，从删除点开始以最后一个元素为参照调用一次siftDown()即可。此处不再赘述

public boolean remove(Object o) {
    int i = indexOf(o);
    if (i == -1)
        return false;
    else {
        removeAt(i);
        return true;
    }
}

private int indexOf(Object o) {
    if (o != null) {
        for (int i = 0; i < size; i++)
            if (o.equals(queue[i]))
                return i;
    }
    return -1;
}

private E removeAt(int i) {
    // assert i >= 0 && i < size;
    modCount++;
    int s = --size;
    if (s == i) // removed last element
        queue[i] = null;
    else {
        E moved = (E) queue[s];
        queue[s] = null;
        siftDown(i, moved);
        if (queue[i] == moved) {
            siftUp(i, moved);
            if (queue[i] != moved)
                return moved;
        }
    }
    return null;
}

参考文章

Collection - PriorityQueue源码解析：https://www.pdai.tech/md/java/collection/java-collection-PriorityQueue.html

Base-Java

🎉 Queue-PriorityQueue

环境和版本

简介

类图

构造函数

remove()和poll()

remove(Object o)

参考文章