【Java基礎】JAVA中優先隊列詳解

總體介紹

優先隊列的作用是能保證每次取出的元素都是隊列中權值最小的（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

通過上述三個公式，可以輕易計算出某個節點的父節點以及子節點的下標。這也就是為什么可以直接用數組來存儲堆的原因。

PriorityQueue的peek()和element操作是常數時間，add(), offer(), 無參數的remove()以及poll()方法的時間復雜度都是log(N)。

方法剖析

add()和offer()

add(E e)和offer(E e)的語義相同，都是向優先隊列中插入元素，只是Queue接口規定二者對插入失敗時的處理不同，前者在插入失敗時拋出異常，后則則會返回false。對於PriorityQueue這兩個方法其實沒什么差別。

新加入的元素可能會破壞小頂堆的性質，因此需要進行必要的調整。

//offer(E e)
public boolean offer(E e) {
    if (e == null)//不允許放入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並維持堆的特性。

//siftUp()
private void siftUp(int k, E x) {
    while (k > 0) {
        int parent = (k - 1) >>> 1;//parentNo = (nodeNo-1)/2
        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]為止。注意這里的比較可以是元素的自然順序，也可以是依靠比較器的順序。

element()和peek()

element()和peek()的語義完全相同，都是獲取但不刪除隊首元素，也就是隊列中權值最小的那個元素，二者唯一的區別是當方法失敗時前者拋出異常，后者返回null。根據小頂堆的性質，堆頂那個元素就是全局最小的那個；由於堆用數組表示，根據下標關系，0下標處的那個元素既是堆頂元素。所以直接返回數組0下標處的那個元素即可。

代碼也就非常簡潔：

//peek()
public E peek() {
    if (size == 0)
        return null;
    return (E) queue[0];//0下標處的那個元素就是最小的那個
}

remove()和poll()

remove()和poll()方法的語義也完全相同，都是獲取並刪除隊首元素，區別是當方法失敗時前者拋出異常，后者返回null。由於刪除操作會改變隊列的結構，為維護小頂堆的性質，需要進行必要的調整。

代碼如下：

public E poll() {
    if (size == 0)
        return null;
    int s = --size;
    modCount++;
    E result = (E) queue[0];//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小於或等於左右孩子中的任何一個為止。

//siftDown()
private void siftDown(int k, E x) {
    int half = size >>> 1;
    while (k < half) {
        //首先找到左右孩子中較小的那個，記錄到c里，並用child記錄其下標
        int child = (k << 1) + 1;//leftNo = parentNo*2+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;//然后用c取代原來的值
        k = child;
    }
    queue[k] = x;
}

remove(Object o)

remove(Object o)方法用於刪除隊列中跟o相等的某一個元素（如果有多個相等，只刪除一個），該方法不是Queue接口內的方法，而是Collection接口的方法。由於刪除操作會改變隊列結構，所以要進行調整；又由於刪除元素的位置可能是任意的，所以調整過程比其它函數稍加繁瑣。具體來說，remove(Object o)可以分為2種情況：1. 刪除的是最后一個元素。直接刪除即可，不需要調整。2. 刪除的不是最后一個元素，從刪除點開始以最后一個元素為參照調用一次siftDown()即可。此處不再贅述。

具體代碼如下：

//remove(Object o)
public boolean remove(Object o) {
    //通過遍歷數組的方式找到第一個滿足o.equals(queue[i])元素的下標
    int i = indexOf(o);
    if (i == -1)
        return false;
    int s = --size;
    if (s == i) //情況1
        queue[i] = null;
    else {
        E moved = (E) queue[s];
        queue[s] = null;
        siftDown(i, moved);//情況2
        ......
    }
    return true;
}

注意事項

PriorityQueue 不是線程安全的 ，因此Java提供了PriorityBlockingQueue類，該類實現了BlockingQueue接口以在Java多線程環境中使用。

使用示例

PriorityQueue實現為入隊和出隊方法提供O(log(n))時間。 讓我們來看一個自然排序以及Comparator的PriorityQueue示例。

我們有自定義類Customer ，它不提供任何類型的排序，因此，當我們嘗試將其與PriorityQueue一起使用時，應為此提供一個比較器對象。

package com.journaldev.collections;
 
public class Customer {
 
	private int id;
	private String name;
 
	public Customer(int i, String n){
		this.id=i;
		this.name=n;
	}
 
	public int getId() {
		return id;
	}
 
	public String getName() {
		return name;
	}
 
}

我們將使用Java隨機數生成來生成隨機的客戶對象。 對於自然排序，我將使用Integer，它也是一個Java包裝器類 。

這是我們的最終測試代碼，顯示了如何使用PriorityQueue。

package com.journaldev.collections;
 
import java.util.Comparator;
import java.util.PriorityQueue;
import java.util.Queue;
import java.util.Random;
 
public class PriorityQueueExample {
 
	public static void main(String[] args) {
 
		//natural ordering example of priority queue
		Queue<Integer> integerPriorityQueue = new PriorityQueue<>(7);
		Random rand = new Random();
		for(int i=0;i<7;i++){
			integerPriorityQueue.add(new Integer(rand.nextInt(100)));
		}
		for(int i=0;i<7;i++){
			Integer in = integerPriorityQueue.poll();
			System.out.println("Processing Integer:"+in);
		}
 
		//PriorityQueue example with Comparator
		Queue<Customer> customerPriorityQueue = new PriorityQueue<>(7, idComparator);
		addDataToQueue(customerPriorityQueue);
 
		pollDataFromQueue(customerPriorityQueue);
 
	}
 
	//Comparator anonymous class implementation
	public static Comparator<Customer> idComparator = new Comparator<Customer>(){
 
		@Override
		public int compare(Customer c1, Customer c2) {
            return (int) (c1.getId() - c2.getId());
        }
	};
 
	//utility method to add random data to Queue
	private static void addDataToQueue(Queue<Customer> customerPriorityQueue) {
		Random rand = new Random();
		for(int i=0; i<7; i++){
			int id = rand.nextInt(100);
			customerPriorityQueue.add(new Customer(id, "Pankaj "+id));
		}
	}
 
	//utility method to poll data from queue
	private static void pollDataFromQueue(Queue<Customer> customerPriorityQueue) {
		while(true){
			Customer cust = customerPriorityQueue.poll();
			if(cust == null) break;
			System.out.println("Processing Customer with ID="+cust.getId());
		}
	}
 
}

請注意，我正在使用java匿名類來實現Comparator接口並創建基於id的比較器。

當我在測試程序上運行時，得到以下輸出：

Processing Integer:9
Processing Integer:16
Processing Integer:18
Processing Integer:25
Processing Integer:33
Processing Integer:75
Processing Integer:77
Processing Customer with ID=6
Processing Customer with ID=20
Processing Customer with ID=24
Processing Customer with ID=28
Processing Customer with ID=29
Processing Customer with ID=82
Processing Customer with ID=96

從輸出中可以明顯看出，最少的元素在首位，並且被首先輪詢。 如果在創建customerPriorityQueue時不提供比較器，它將在運行時引發ClassCastException。

Exception in thread "main" java.lang.ClassCastException: com.journaldev.collections.Customer cannot be cast to java.lang.Comparable
	at java.util.PriorityQueue.siftUpComparable(PriorityQueue.java:633)
	at java.util.PriorityQueue.siftUp(PriorityQueue.java:629)
	at java.util.PriorityQueue.offer(PriorityQueue.java:329)
	at java.util.PriorityQueue.add(PriorityQueue.java:306)
	at com.journaldev.collections.PriorityQueueExample.addDataToQueue(PriorityQueueExample.java:45)
	at com.journaldev.collections.PriorityQueueExample.main(PriorityQueueExample.java:25)