[學習筆記-Java集合-14] Queue - PriorityQueue源碼分析

介紹

優先級隊列，是0個或多個元素的集合，集合中的每一個元素都有一個權重值，每次出隊都彈出優先級最大或最小的元素。

通常來講，優先級隊列使用堆來實現。

源碼分析

主要屬性

// 默認容量
    private static final int DEFAULT_INITIAL_CAPACITY = 11;
    // 存儲元素的地方
    transient Object[] queue; // non-private to simplify nested class access
    // 元素個數
    private int size = 0;
    // 比較器
    private final Comparator<? super E> comparator;
    // 修改次數
    transient int modCount = 0; // non-private to simplify nested class access

1. 默認容量是11；
2. queue，元素存儲在數組中，這跟咱們以前說的堆通常使用數組來存儲是一致的；
3. comparator，比較器，在優先級隊列中，也有兩種方式比較元素，一種是元素的天然順序，一種是經過比較器來比較；
4. modCount，修改次數，有這個屬性表示PriorityQueue也是fast-fail的；

入隊

入隊有兩個方法，add(E e)和offer(E e)，二者是一致的，add(E e)也是調用的offer(E e)。

public boolean add(E e) {
    return offer(e);
}

public boolean offer(E e) {
    // 不支持null元素
    if (e == null)
        throw new NullPointerException();
    modCount++;
    // 取size
    int i = size;
    // 元素個數達到最大容量了，擴容
    if (i >= queue.length)
        grow(i + 1);
    // 元素個數加1
    size = i + 1;
    // 若是尚未元素
    // 直接插入到數組第一個位置
    // 這裏跟咱們以前講堆不同了
    // java裏面是從0開始的
    // 咱們說的堆是從1開始的
    if (i == 0)
        queue[0] = e;
    else
        // 不然，插入元素到數組size的位置，也就是最後一個元素的下一位
        // 注意這裏的size不是數組大小，而是元素個數
        // 而後，再作自下而上的堆化
        siftUp(i, e);
    return true;
}

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) {
        // 找到父節點的位置
        // 由於元素是從0開始的，因此減1以後再除以2
        int parent = (k - 1) >>> 1;
        // 父節點的值
        Object e = queue[parent];
        // 比較插入的元素與父節點的值
        // 若是比父節點大，則跳出循環
        // 不然交換位置
        if (key.compareTo((E) e) >= 0)
            break;
        // 與父節點交換位置
        queue[k] = e;
        // 如今插入的元素位置移到了父節點的位置
        // 繼續與父節點再比較
        k = parent;
    }
    // 最後找到應該插入的位置，放入元素
    queue[k] = key;
}

1. 入隊不容許null元素；
2. 若是數組不夠用了，先擴容；
3. 若是尚未元素，就插入下標0的位置；
4. 若是有元素了，就插入到最後一個元素日後的一個位置（實際並無插入哈）；
5. 自下而上堆化，一直往上跟父節點比較；
6. 若是比父節點小，就與父節點交換位置，直到出現比父節點大爲止；
7. 因而可知，PriorityQueue是一個小頂堆。

擴容

private void grow(int minCapacity) {
    // 舊容量
    int oldCapacity = queue.length;
    // Double size if small; else grow by 50%
    // 舊容量小於64時，容量翻倍
    // 舊容量大於等於64，容量只增長舊容量的一半
    int newCapacity = oldCapacity + ((oldCapacity < 64) ?
                                     (oldCapacity + 2) :
                                     (oldCapacity >> 1));
    // overflow-conscious code
    // 檢查是否溢出
    if (newCapacity - MAX_ARRAY_SIZE > 0)
        newCapacity = hugeCapacity(minCapacity);

    // 建立出一個新容量大小的新數組並把舊數組元素拷貝過去
    queue = Arrays.copyOf(queue, newCapacity);
}

private static int hugeCapacity(int minCapacity) {
    if (minCapacity < 0) // overflow
        throw new OutOfMemoryError();
    return (minCapacity > MAX_ARRAY_SIZE) ?
        Integer.MAX_VALUE :
        MAX_ARRAY_SIZE;
}

1. 當數組比較小（小於64）的時候每次擴容容量翻倍；
2. 當數組比較大的時候每次擴容只增長一半的容量；

出隊

出隊有兩個方法，remove()和poll()，remove()也是調用的poll()，只是沒有元素的時候拋出異常。

public E remove() {
    // 調用poll彈出隊首元素
    E x = poll();
    if (x != null)
        // 有元素就返回彈出的元素
        return x;
    else
        // 沒有元素就拋出異常
        throw new NoSuchElementException();
}

@SuppressWarnings("unchecked")
public E poll() {
    // 若是size爲0，說明沒有元素
    if (size == 0)
        return null;
    // 彈出元素，元素個數減1
    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;
}

private void siftDown(int k, E x) {
    // 根據是否有比較器，選擇不一樣的方法
    if (comparator != null)
        siftDownUsingComparator(k, x);
    else
        siftDownComparable(k, x);
}

@SuppressWarnings("unchecked")
private void siftDownComparable(int k, E x) {
    Comparable<? super E> key = (Comparable<? super E>)x;
    // 只須要比較一半就好了，由於葉子節點佔了一半的元素
    int half = size >>> 1;        // loop while a non-leaf
    while (k < half) {
        // 尋找子節點的位置，這裏加1是由於元素從0號位置開始
        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;
        // 若是比最小的子節點大，則交換位置
        queue[k] = c;
        // 指針移到最小子節點的位置繼續往下比較
        k = child;
    }
    // 找到正確的位置，放入元素
    queue[k] = key;
}

1. 將隊列首元素彈出；
2. 將隊列末元素移到隊列首；
3. 自上而下堆化，一直往下與最小的子節點比較；
4. 若是比最小的子節點大，就交換位置，再繼續與最小的子節點比較；
5. 若是比最小的子節點小，就不用交換位置了，堆化結束；
6. 這就是堆中的刪除堆頂元素；

取隊首元素

取隊首元素有兩個方法，element()和peek()，element()也是調用的peek()，只是沒取到元素時拋出異常。

public E element() {
    E x = peek();
    if (x != null)
        return x;
    else
        throw new NoSuchElementException();
}
public E peek() {
    return (size == 0) ? null : (E) queue[0];
}

1. 若是有元素就取下標0的元素；
2. 若是沒有元素就返回null，element()拋出異常；

總結

1. PriorityQueue是一個小頂堆；
2. PriorityQueue是非線程安全的；
3. PriorityQueue不是有序的，只有堆頂存儲着最小的元素；
4. 入隊就是堆的插入元素的實現；
5. 出隊就是堆的刪除元素的實現；