PriorityQueue

PriorityQueue

优先队列的作用是保证每次取出的元素都是队列中权值最小的。通过二叉小顶堆实现，可以用一棵完全二叉树表示。底层是通过数组实现的。（元素不能为空）。

基本成员变量

//默认容量
   private static final int DEFAULT_INITIAL_CAPACITY = 11;
//数组，用来存储数据
   private transient Object[] queue;
//优先队列中的元素数量。
    private int size = 0;
//比较器，如果优先队列使用元素的自然排序，则为null。
    private final Comparator<? super E> comparator;
//修改次数
    private transient int modCount = 0;

构造函数

//默认构造函数，长度为默认容量
    public PriorityQueue() {
        this(DEFAULT_INITIAL_CAPACITY, null);
    }
//有参构造函数，长度为传入的参数值
    public PriorityQueue(int initialCapacity) {
        this(initialCapacity, null);
    }
//有两个参数的构造函数，长度为initialCapacity，比较器为comparator
    public PriorityQueue(int initialCapacity,
                         Comparator<? super E> comparator) {
        if (initialCapacity < 1)
            throw new IllegalArgumentException();
        this.queue = new Object[initialCapacity];
        this.comparator = comparator;
    }

扩容

    private void grow(int minCapacity) {
        int oldCapacity = queue.length;
        //如果原容量<64，扩容方式为2*old+2，当>64时，
        int newCapacity = oldCapacity + ((oldCapacity < 64) ? (oldCapacity + 2) :(oldCapacity >> 1));
        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;
    }

添加元素

//调用offer（）添加元素
    public boolean add(E e) {
        return offer(e);
    }

    public boolean offer(E e) {
        //如果添加的元素为null，抛出异常
        if (e == null)
            throw new NullPointerException();
        modCount++;
        int i = size;
        //如果超过容量，先进行扩容
        if (i >= queue.length)
            grow(i + 1);
        size = i + 1;
        //如果容量为0直接将元素放入到0号下标
        if (i == 0)
            queue[0] = e;
        else
        //进行添加，并调整
            siftUp(i, e);
        return true;
    }

返回队列起始位置的值

    public E peek() {
    //如果队列内没有元素，则返回null
        if (size == 0)
            return null;
        return (E) queue[0];
    }

返回指定元素的下标，如果没有找到返回-1

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

删除

//删除指定元素
    public boolean remove(Object o) {
    //调用indexOf（）方法找到要删除的元素所在的位置，然后删除
        int i = indexOf(o);
        if (i == -1)
            return false;
        else {
            removeAt(i);
            return true;
        }
    }
//删除指定元素
    boolean removeEq(Object o) {
    //通过循环遍历找到指定元素，然后删除
        for (int i = 0; i < size; i++) {
            if (o == queue[i]) {
                removeAt(i);
                return true;
            }
        }
        return false;
    }

检查队列中是否含有指定元素

    public boolean contains(Object o) {
        return indexOf(o) != -1;
    }

返回包含该队列中所有元素的数组

//无参
    public Object[] toArray() {
        return Arrays.copyOf(queue, size);
    }
//有参
    public <T> T[] toArray(T[] a) {
        if (a.length < size)
            return (T[]) Arrays.copyOf(queue, size, a.getClass());
        System.arraycopy(queue, 0, a, 0, size);
        if (a.length > size)
            a[size] = null;
        return a;
    }

返回队列长度

    public int size() {
        return size;
    }

清空队列

    public void clear() {
        modCount++;
        for (int i = 0; i < size; i++)
            queue[i] = null;
        size = 0;
    }

返回队列头部元素，并删除

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

删除指定位置元素

    private E removeAt(int i) {
        assert i >= 0 && i < size;
        modCount++;
        int s = --size;
        //如果删除的是最后一个元素，直接置空
        if (s == i) 
            queue[i] = null;
        else {
        //获取最后一个元素，然后将最后一个元素置空
            E moved = (E) queue[s];
            queue[s] = null;
            //将获取的最后一个元素，放在i号位置，然后用siftDown调整
            siftDown(i, moved);
            //如果moved还在i号位置，用siftUp重新调整
            if (queue[i] == moved) {
                siftUp(i, moved);
                //如果moved不在i号位置，返回该值
                if (queue[i] != moved)
                    return moved;
            }
        }
        return null;
    }

向上调整

    private void siftUp(int k, E x) {
        if (comparator != null)
            siftUpUsingComparator(k, x);
        else
            siftUpComparable(k, x);
    }
//当没有比较器时的调整过程
  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];
            //x与父节点比较，父节点不大于x时跳出
            if (key.compareTo((E) e) >= 0)
                break;
            //父节点较大时，将父节点的值放在当前位置，k向上移动
            queue[k] = e;
            k = parent;
        }
        //将key值放在当前k所在的位置
        queue[k] = key;
    }
//当有比较器时的调整过程
    private void siftUpUsingComparator(int k, E x) {
        while (k > 0) {
            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;
    }

向下调整

 private void siftDown(int k, E x) {
        if (comparator != null)
            siftDownUsingComparator(k, x);
        else
            siftDownComparable(k, x);
    }
//当没有比较器时的调整过程
    private void siftDownComparable(int k, E x) {
        Comparable<? super E> key = (Comparable<? super E>)x;
        //
        int half = size >>> 1;        
        while (k < half) {
        //左孩子
            int child = (k << 1) + 1; 
            Object c = queue[child];
        //右孩子
            int right = child + 1;
        //右孩子存在，并且左孩子大于右孩子，将较小右孩子的值赋给c
            if (right < size &&
                ((Comparable<? super E>) c).compareTo((E) queue[right]) > 0)
                c = queue[child = right];
         //当孩子节点中较小的值大于当前值时，跳出
            if (key.compareTo((E) c) <= 0)
                break;
         //当前值较大时，将孩子节点中较小的值放在当前位置，k向下移动
            queue[k] = c;
            k = child;
        }
        //将key值放在当前k所在的位置
        queue[k] = key;
    }
//当有比较器时的调整过程
    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;
    }

调整整个队列

    private void heapify() {
        for (int i = (size >>> 1) - 1; i >= 0; i--)
            siftDown(i, (E) queue[i]);
    }