Implemented Treap and Treap tests.

SystemExtensions/Collections/PriorityQueue.cs

@@ -6,13 +6,20 @@ using System.Threading.Tasks;
 
 namespace SystemExtensions.Collections
 {
+    /// <summary>
+    /// Priority Queue data structure. The implementation is based on an array-based implementation of Binary Heap.
+    /// Exposes some of the functionality of the Binary Heap as a queue.
+    /// </summary>
+    /// <typeparam name="T">Provided type.</typeparam>
     public class PriorityQueue<T>
     {
         #region Fields
         private BinaryHeap<T> binaryHeap;
         #endregion
-
         #region Properties
+        /// <summary>
+        /// Returns the number of elements stored into the queue.
+        /// </summary>
         public int Count
         {
             get
@@ -21,20 +28,29 @@ namespace SystemExtensions.Collections
             }
         }
         #endregion
-
         #region Constructors
+        /// <summary>
+        /// Constructor for priority queue data structure.
+        /// </summary>
+        /// <param name="comparator">Function used to compare the elements.</param>
         public PriorityQueue(Comparison<T> comparator)
         {
             binaryHeap = new BinaryHeap<T>(comparator);
         }
         #endregion
-
         #region Public Methods
+        /// <summary>
+        /// Add provided value to the queue.
+        /// </summary>
+        /// <param name="value">Value to be added to the queue.</param>
         public void Enqueue(T value)
         {
             binaryHeap.Insert(value);
         }
-
+        /// <summary>
+        /// Pops the queue and removes the highest priority value from the queue.
+        /// </summary>
+        /// <returns>Highest priority value from the queue</returns>
         public T Dequeue()
         {
             if (Count > 0)
@@ -46,18 +62,22 @@ namespace SystemExtensions.Collections
                 throw new IndexOutOfRangeException("Queue is empty!");
             }
         }
-
+        /// <summary>
+        /// Looks up the highest priority value from the queue. Doesn't alter the queue in any way.
+        /// </summary>
+        /// <returns>Highest priority value from the queue.</returns>
         public T Peek()
         {
             return binaryHeap.Min;
         }
-
+        /// <summary>
+        /// Clears the queue contents, removing any value stored into the queue.
+        /// </summary>
         public void Clear()
         {
             binaryHeap.Clear();
         }
         #endregion
-
         #region Private Methods
         #endregion
     }