Document the breaking changes to PriorityQueue

swadey · Aug 19, 2014 · dcf18a9 · dcf18a9
1 parent 42fe521
commit dcf18a9
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/NEWS.md b/NEWS.md
@@ -15,6 +15,16 @@ Library improvements
 
   * Symmetric and Hermitian immutables are now parametrized on matrix type ([#7992]).
 
+  * Switch from `O(N)` to `O(logN)` algorithm for `dequeue!(pq, key)`
+    with PriorityQueues. This provides major speedups for large
+    queues.
+
+  * PriorityQueues now include the order type among their parameters,
+    `PriorityQueue{KeyType,ValueType,OrderType}`. An empty queue can
+    be constructed as `pq = PriorityQueue(KeyType,ValueType)`, if you
+    intend to use the default `Forward` order, or
+    `pq = PriorityQueue(KeyType, ValueType, OrderType)` otherwise.
+
 Julia v0.3.0 Release Notes
 ==========================
 

diff --git a/doc/stdlib/collections.rst b/doc/stdlib/collections.rst
@@ -14,7 +14,7 @@ The ``PriorityQueue`` type is a basic priority queue implementation allowing for
 arbitrary key and priority types. Multiple identical keys are not permitted, but
 the priority of existing keys can be changed efficiently.
 
-.. function:: PriorityQueue{K,V}([ord])
+.. function:: PriorityQueue(K, V, [ord])
 
    Construct a new PriorityQueue, with keys of type ``K`` and values/priorites of
    type ``V``. If an order is not given, the priority queue is min-ordered using