Java PriorityQueue

PriorityQueue源码浅析

特点

数据按小根堆存储，堆一定是完全二叉树，因此可以通过数组存储。
叶子节点的下标一定大于size/2。

实现

	//默认初始容量
    private static final int DEFAULT_INITIAL_CAPACITY = 11;

	//数组实现的小根堆
    transient Object[] queue; // non-private to simplify nested class access

    //队列中的元素数量
    int size;

    @SuppressWarnings("serial") // Conditionally serializable
    private final Comparator<? super E> comparator;
	
    transient int modCount;     // non-private to simplify nested class access

声明

容量和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;
    }

参数为集合的构造函数

• 当传入的集合为SortSet的子类时，将优先队列的Comparator设置为SortedSet的Comparator；
• 当传入的集合是优先队列时，将本优先队列的Comparator设置为与参数优先队列一致；
• 为其他集合时，不设置比较器。

    public PriorityQueue(Collection<? extends E> c) {
        if (c instanceof SortedSet<?>) {
            SortedSet<? extends E> ss = (SortedSet<? extends E>) c;
            this.comparator = (Comparator<? super E>) ss.comparator();
            initElementsFromCollection(ss);
        }
        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);
        }
    }

然后调用对应的初始化方法初始化Object[] queue;
SortedSet：

    private void initElementsFromCollection(Collection<? extends E> c) {
        Object[] es = c.toArray();
        int len = es.length;
        if (c.getClass() != ArrayList.class)
            es = Arrays.copyOf(es, len, Object[].class);
        if (len == 1 || this.comparator != null)
            for (Object e : es)
                if (e == null)
                    throw new NullPointerException();
		//之前的集合类已经排好了序
        this.queue = ensureNonEmpty(es);
        this.size = len;
    }

PriorityQueue：

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

普通Collection:

    private void initFromCollection(Collection<? extends E> c) {
        initElementsFromCollection(c); //直接调用
        heapify(); //但是由于元素顺序不合要求，需要调整堆，调整见后序
    }

是否包含某元素

调用indexOf方法，如果下标>=0说明元素存在；

    public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }

indexOf方法本质上就是顺序查找queue数组，所以只能找到第一个值

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

弹出队首元素

    public E poll() {
        final Object[] es;
        final E result;
		// es = queue; result = (E)es[0]; result != null
        if ((result = (E) ((es = queue)[0])) != null) {
            modCount++; //修改次数+1
            final int n;
            final E x = (E) es[(n = --size)]; //获取队尾元素
            es[n] = null; //将队尾位置置为ull
            if (n > 0) {
                final Comparator<? super E> cmp;
				//如果comparator == null，则通过元素的compareTo进行比较
				//否则通过comparator进行比较
                if ((cmp = comparator) == null)
				    //弹出队首元素之后需要向下调整
                    siftDownComparable(0, x, es, n);
                else
                    siftDownUsingComparator(0, x, es, n, cmp);
            }
        }
        return result;
    }

	//k是被删除元素的下标，x是需要调整的元素的值
    private static <T> void siftDownComparable(int k, T x, Object[] es, int n) {
        // assert n > 0;
        Comparable<? super T> key = (Comparable<? super T>)x;
        int half = n >>> 1;           // loop while a non-leaf
        while (k < half) {
            int child = (k << 1) + 1; // assume left child is least
            Object c = es[child];
            int right = child + 1;
			//取得左右子节点中的最小值
            if (right < n &&
                ((Comparable<? super T>) c).compareTo((T) es[right]) > 0)
                c = es[child = right];
			//如果key的值比左右子节点的最小值小，说明找到了一个合适的位置
            if (key.compareTo((T) c) <= 0)
                break;
			//否则k的子节点的较小者作为新的父节点
            es[k] = c;
			//继续向下寻找
            k = child;
        }
		//将Key赋给k位置
        es[k] = key;
    }

插入元素

    public boolean offer(E e) {
        if (e == null)
            throw new NullPointerException();
        modCount++;
        int i = size;
        if (i >= queue.length)
            grow(i + 1); //空间增长
        siftUp(i, e); //向上调整
        size = i + 1;
        return true;
    }

    private static <T> void siftUpComparable(int k, T x, Object[] es) {
        Comparable<? super T> key = (Comparable<? super T>) x;
        while (k > 0) {
            int parent = (k - 1) >>> 1;
            Object e = es[parent];
            if (key.compareTo((T) e) >= 0)
                break;
            es[k] = e;
            k = parent;
        }
        es[k] = key;
    }