PriorityQueue小顶堆

Java中PriorityQueue通过二叉小顶堆实现，可以用一棵完全二叉树表示。PriorityQueue位于Java util包中，观其名字前半部分的单词Priority是优先的意思，实际上这个队列就是具有“优先级”。既然具有优先级的特性，那么就得有个前后排序的“规则”。所以其接受的类需要实现Comparable 接口。该队列线程安全，不允许null值，入队和出队的时间复杂度是O（log(n)）。

对于大根堆，就要借助于comparator比较器，来实现大根堆。（使用默认的初始容量：11）

PriorityQueue  maxHeap = new PriorityQueue(11, new Comparator() {

    @Override
    public int compare(Integer o1, Integer o2) {
        // TODO Auto-generated method stub
        return o2.compareTo(o1);
    }

});

API

1.构造函数

PriorityQueue()
PriorityQueue(Collectionextends E> c)
PriorityQueue(int initialCapacity)
PriorityQueue(int initialCapacity, Comparatorsuper E> comparator)
PriorityQueue(PriorityQueueextends E> c)
PriorityQueue(SortedSetextends E> c)

2.常用功能函数

方法名	功能描述
add(E e)	添加元素
clear()	清空
contains(Object o)	检查是否包含当前参数元素
offer(E e)	添加元素
peek()	读取元素，（不删除）
poll()	取出元素，（删除）
remove(Object o)	删除指定元素
size()	返回长度

方法剖析

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;
}

用法示例

上面提到具有优先级，那么这里举个例子。我在上高中的时候，每月分一次班级，老师会按照本月月考的成绩来让每位同学优先选择自己心仪的座位。这里所有的同学便是一个队列；每次喊一个人进来挑选座位，这便是出对的操作；成绩由前至后，这边是优先的策略。

• 代码示例如下：

public class PriorityQueueTest {
    public static void main(String[] args) {
                
        final PriorityQueue queue=new PriorityQueue<>();

        Student p1=new Student(95,"张三");
        Student p2=new Student(89,"李四");
        Student p3=new Student(89,"李四");
        Student p4=new Student(67,"王五");
        Student p5=new Student(92,"赵六");
        queue.add(p1);
        queue.add(p2);
        queue.add(p3);//add 和offer效果一样。
        queue.offer(p4);//add 方法实现，其实就是调用了offer
        queue.offer(p5)

        for (Student Student : queue) {
            System.out.println(Student.toString());
        }
        
        System.out.println("---------------------");
        while(!queue.isEmpty()){
            System.out.println(queue.poll());
        }       
    }

}
class Student implements Comparable{
    private int score;
    private String name;
    
    public Student(int age,String name){
        this.score=age;
        this.name=name;
    }
    public int getScore() {
        return score;
    }
    public void setScore(int score) {
        this.score = score;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String toString(){
        return "姓名："+name+"-"+score+"分";
    }

    @Override
    public int compareTo(Object o) {
        Student current=(Student)o;
        if(current.getScore()>this.score){
            return 1;
        }else if(current.getScore()==this.score){
            return 0;
        }
        return -1;
    }
}

• 运行结果：
  姓名：张三-95分
  姓名：赵六-92分
  姓名：王五-67分
  姓名：李四-89分
  ---------按顺序出队选座位------------
  姓名：张三-95分
  姓名：赵六-92分
  姓名：李四-89分
  姓名：李四-89分
  姓名：王五-67分

从第一部分输出可以看出，学生入队并不是 按顺序的，而在poll出来的时候是按顺序出队的，这里确实实现了分数高这优先选座位的效果，poll方法返回的总是队列剩余学生中分数最高的。

安全性

查看PriorityQueue类的源码，会发现增加操作，并不是原子操作。没有使用任何锁。那么，如果是在多线程环境，肯定是不安全的。下面给出例子，开启多个线程，调用同一个方法对Queue进行添加元素。然后输出结果。

public class PriorityQueueTest {

    static final PriorityQueue queue=new PriorityQueue<>();
    /**
     * 向队列中插入元素
     * @param number
     */
    public  void add(int number){
        if(!queue.contains(number)){
            System.out.println(Thread.currentThread()+"："+number);
            queue.add(number);
        }
    }   

public static void main(String[] args) throws InterruptedException {
    final PriorityQueueTest qt=new PriorityQueueTest();
        final Random r=new Random();
        Thread t1=new Thread(){
            public void run(){
                System.out.println("t1开始运行...");
                for(int i=0;i<10;i++){
                    qt.add(r.nextInt(10));
                }
            }
        };
        Thread t2=new Thread(){
            public void run(){
                System.out.println("t2开始运行...");
                for(int i=0;i<10;i++){
                    qt.add(r.nextInt(10));
                }
            }
        };
        Thread t3=new Thread(){
            public void run(){
                System.out.println("t3开始运行...");
                for(int i=0;i<10;i++){
                    qt.add(r.nextInt(10));
                }
            }
        };
        t1.start();
        t2.start();
        t3.start();
        t1.join();
        t2.join();
        t3.join();
        System.out.println("------ 运行结果 ---------");
        while(!queue.isEmpty()){
            System.out.println(queue.poll());
        }
    }
}

• 运行结果
  t2开始运行...
  t3开始运行...
  t1开始运行...
  ------ 运行结果 ---------
  0
  1
  1
  2
  3
  4
  5
  6
  7
  8
  9
  9

结果中我们可以看到，具有两个1，两个9.这是不符合我们预期的，我们预期的是not contains 才插入，现在的出现的了重复的。上面的例子只需要在add方法上加锁，才可以达到我们预期的效果。所以说，PriorityQueue是非线程安全的。