v2.0.0 release

Author: mikkul

PriorityQueues/BinaryPriorityQueue.cs

@@ -52,14 +52,13 @@ public BinaryPriorityQueue(IEnumerable<T> collection, Comparison<T> comparer)
 			_heap = new List<T>(collection.Count());
 			_comparer = comparer;
 
-			int i = 0;
 			foreach (var elem in collection)
 			{
 				_heap.Add(elem);
 			}
 
 			// heapify process
-			for (int j = Math.Max(0, (_heap.Count / 2) - 1); j >= 0; j--)
+			for (int i = Math.Max(0, (_heap.Count / 2) - 1); i >= 0; i--)
 			{
 				Sink(i);
 			}
@@ -243,6 +242,7 @@ protected virtual T RemoveAt(int index)
 		#endregion
 
 		#region IEnumerable interface implementation
+		/// <inheritdoc/>
 		public IEnumerator<T> GetEnumerator()
 		{
 			return ((IEnumerable<T>)_heap).GetEnumerator();

PriorityQueues/FibonacciPriorityQueue.cs

@@ -41,7 +41,7 @@ internal QueueElement(T value, double priority)
 			}
 
 			/// <summary>
-			/// The actual <see cref="T"/>
+			/// The actual value of the user-specified type
 			/// </summary>
 			public T Value { get; set; }
 
@@ -52,7 +52,7 @@ internal QueueElement(T value, double priority)
 		}
 
 		/// <summary>
-		/// 
+		/// Represents a single node in the fibonacci heap
 		/// </summary>
 		public sealed class Node
 		{
@@ -82,8 +82,10 @@ internal Node(QueueElement value)
 		/// <summary>
 		/// Initializes a new instance of the <see cref="FibonacciPriorityQueue{T}"/> class that is empty
 		/// </summary>
+		/// <param name="type">The type of this priority queue used for comparing nodes</param>
 		public FibonacciPriorityQueue(PriorityQueueType type)
 		{
+			Type = type;
 			if(type == PriorityQueueType.Maximum)
 			{
 				_isMaxHeap = true;
@@ -119,10 +121,8 @@ public FibonacciPriorityQueue(Comparison<QueueElement> comparer)
 		/// </summary>
 		/// <param name="collection">The collection whose elements are copied to the <see cref="FibonacciPriorityQueue{T}"/></param>
 		/// <param name="comparer"></param>
-		public FibonacciPriorityQueue(IEnumerable<T> collection, Comparison<QueueElement> comparer)
+		public FibonacciPriorityQueue(IEnumerable<T> collection, Comparison<QueueElement> comparer) : this(comparer)
 		{
-			_comparer = comparer;
-			_hasCustomComparer = true;
 			foreach (var element in collection)
 			{
 				Enqueue(element);
@@ -133,6 +133,11 @@ public FibonacciPriorityQueue(IEnumerable<T> collection, Comparison<QueueElement
 		#region Public properties
 		/// <inheritdoc/>
 		public int Count => _count;
+
+		/// <summary>
+		/// Gets the type of this priority queue
+		/// </summary>
+		public PriorityQueueType Type { get; }
 		#endregion
 
 		#region Public methods
@@ -155,10 +160,10 @@ public bool Contains(T element)
 		}
 
 		/// <summary>
-		/// 
+		/// Sets a new priority for the specified node. The new value has to be lower if the <see cref="Type"/> is <see cref="PriorityQueueType.Maximum"/> or higher if the <see cref="Type"/> is <see cref="PriorityQueueType.Minimum"/>
 		/// </summary>
-		/// <param name="node"></param>
-		/// <param name="newPriority"></param>
+		/// <param name="node"><see cref="Node"/> to be modified</param>
+		/// <param name="newPriority">A finite value representing the new priority</param>
 		public void DecreaseKey(Node node, double newPriority)
 		{
 			if(double.IsNaN(newPriority))
@@ -281,7 +286,7 @@ public void Enqueue(T element)
 		/// /// <exception cref="ArgumentNullException"></exception>
 		/// <param name="element">The element to be added to the queue</param>
 		/// <param name="priority">The priority value</param>
-		public void Enqueue(T element, double priority)
+		public Node Enqueue(T element, double priority)
 		{
 			if(element == null)
 			{
@@ -293,6 +298,8 @@ public void Enqueue(T element, double priority)
 			_minNode = MergeLists(_minNode, newNode);
 
 			_count++;
+
+			return newNode;
 		}
 
 		/// <inheritdoc/>
@@ -321,9 +328,9 @@ public bool Remove(T element)
 		}
 
 		/// <summary>
-		/// 
+		/// Removes a node from the queue
 		/// </summary>
-		/// <param name="node">Node to be removed</param>
+		/// <param name="node"><see cref="Node"/> to be removed</param>
 		public void Remove(Node node)
 		{
 			if(_hasCustomComparer)

PriorityQueues/MappedBinaryPriorityQueue.cs

@@ -52,7 +52,7 @@ public MappedBinaryPriorityQueue(IEnumerable<T> collection, Comparison<T> compar
 			// heapify process
 			for (int j = Math.Max(0, (_heap.Count / 2) - 1); j >= 0; j--)
 			{
-				Sink(i);
+				Sink(j);
 			}
 		}
 		#endregion

PriorityQueues/PriorityQueues.csproj

@@ -7,11 +7,26 @@
     <UpgradeBackupLocation />
     <ProjectGuid>{68BC24ED-9C80-4BE1-8FBC-21E42AF7E1BD}</ProjectGuid>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
+    <Authors>Mikołaj Kuleszow</Authors>
+    <PackageProjectUrl>https://github.com/mikkul/PriorityQueue</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/mikkul/PriorityQueue</RepositoryUrl>
+    <PackageTags>priorityqueue, heap, pq, comparer, collection</PackageTags>
+    <Company />
+    <Copyright>Copyright 2021</Copyright>
+    <PackageLicenseExpression></PackageLicenseExpression>
+    <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
+    <Version>2.0.0</Version>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)' == 'Debug'">
     <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)' == 'Release'">
     <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DocumentationFile>D:\C#_Stuff\PriorityQueue\PriorityQueues\PriorityQueues.xml</DocumentationFile>
+  </PropertyGroup>
+	<ItemGroup>
+		<None Include="LICENSE.txt" Pack="true" PackagePath="" />
+	</ItemGroup>
 </Project>