RecyclableSortedList added

Recyclable.Collections/Recyclable.Collections.csproj

@@ -15,10 +15,17 @@
 		<Description>Recyclable.Collections project is an open source framework for operating dynamic lists at performance close to raw arrays. It aims at providing high performance with minimal memory footprint. It implements IList&lt;T&gt;'s interface and is targeted as direct replacements of List&lt;T&gt;, SortableList&lt;T&gt;, PriorityQueue&lt;T&gt; and similar.
 		
 		The project &amp; source code is free for educational, open-source &amp; personal use.</Description>
+		<ProjectUrl>https://github.com/mlemanczyk/Recyclable.Collections</ProjectUrl>
+		<RepositoryUrl>https://github.com/mlemanczyk/Recyclable.Collections</RepositoryUrl>
+		<Copyright>Marek Lemańczyk 2023</Copyright>
+		<LicenseUrl>https://github.com/mlemanczyk/Recyclable.Collections</LicenseUrl>
+		<Readme>/README.md</Readme>
 	</PropertyGroup>
 
 	<ItemGroup>
-	  <Compile Remove="RecyclableSortedList.cs" />
+	  <None Include="..\README.md" Link="README.md">
+	    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+	  </None>
 	</ItemGroup>
 
 </Project>

Recyclable.Collections/RecyclableSortedList.cs

@@ -0,0 +1,43 @@
+namespace Recyclable.Collections
+{
+	public class RecyclableSortedList<TKey, TValue> : RecyclableList<(TKey Key, TValue Value)>
+		where TKey : notnull
+	{
+		private static readonly IComparer<(TKey, TValue)> _comparer = new FrequencyTupleComparer<TKey, TValue>();
+		private readonly SystemRandomNumberGenerator _randomNumberGenerator = new SystemRandomNumberGenerator();
+
+		protected override void ListUpdated()
+		{
+			base.ListUpdated();
+			QuickSort();
+		}
+
+		public RecyclableSortedList() : base()
+		{
+		}
+
+		public RecyclableSortedList(Dictionary<TKey, TValue> source, int blockSize = RecyclableDefaults.BlockSize)
+			: this(source.Select(x => (x.Key, x.Value)), blockSize)
+		{
+		}
+
+		public RecyclableSortedList(IEnumerable<(TKey Key, TValue Value)> source, int blockSize = RecyclableDefaults.BlockSize)
+			: base(source, blockSize)
+		{
+			QuickSort();
+		}
+
+		public void QuickSort()
+		{
+			_isUpdating++;
+			try
+			{
+				this.QuickSort(_comparer, _randomNumberGenerator);
+			}
+			finally
+			{
+				_isUpdating--;
+			}		
+		}
+	}
+}

Recyclable.CollectionsTests/Recyclable.CollectionsTests.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>
@@ -8,10 +8,6 @@
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
-  <ItemGroup>
-    <Compile Remove="RecyclableSortedListTests.cs" />
-  </ItemGroup>
-
   <ItemGroup>
     <PackageReference Include="FluentAssertions" Version="6.8.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />

Recyclable.CollectionsTests/RecyclableSortedListTests.cs

@@ -0,0 +1,88 @@
+using FluentAssertions;
+using Recyclable.Collections;
+
+namespace Recyclable.CollectionsTests
+{
+	[TestClass()]
+	public class RecyclableSortedListTests
+	{
+		private static readonly (int, string)[] _testData = new[] { (5, "a"), (4, "d"), (3, "c"), (2, "b"), (1, "a") };
+
+		[TestMethod]
+		public void ShouldBeSortedWhenCreated()
+		{
+			// Act
+			using var sortedList = new RecyclableSortedList<int, string>(_testData);
+
+			// Validate
+			_ = sortedList.Should().HaveCount(_testData.Length)
+				.And.BeEquivalentTo(_testData)
+				.And.BeInAscendingOrder((item) => item.Key);
+		}
+
+		[TestMethod]
+		public void ShouldBeEmptyWhenNotInitialized()
+		{
+			// Act
+			using var sortedList = new RecyclableSortedList<int, string>();
+
+			// Validate
+			_ = sortedList.Should().BeEmpty();
+		}
+
+		[TestMethod]
+		public void ShouldBeSortedWhenInitialized()
+		{
+			// Act
+			using var sortedList = new RecyclableSortedList<int, string>()
+			{
+				_testData[0],
+				_testData[1],
+				_testData[2],
+				_testData[3],
+				_testData[4]
+			};
+
+			// Validate
+			_ = sortedList.Should().NotBeEmpty()
+				.And.BeInAscendingOrder(x => x.Key)
+				.And.BeEquivalentTo(_testData);
+		}
+
+		[TestMethod]
+		public void ShouldBeSortedWhenUpdateEnds()
+		{
+			// Prepare
+			using var sortedList = new RecyclableSortedList<int, string>();
+
+			// Act
+			sortedList.BeginUpdate();
+			foreach (var testItem in _testData)
+			{
+				sortedList.Add(testItem);
+			}
+
+			// Validate
+			_ = sortedList.Should().BeInDescendingOrder(x => x.Key);
+
+			// Act
+			sortedList.EndUpdate();
+
+			// Validate
+			_ = sortedList.Should().BeInAscendingOrder(x => x.Key);
+		}
+
+		[TestMethod]
+		public void ShouldBeEmptyAfterClear()
+		{
+			// Prepare
+			using var sortedList = new RecyclableSortedList<int, string>(_testData);
+
+			// Act
+			sortedList.Clear();
+
+			// Validate
+			_ = sortedList.Should().BeEmpty();
+		}
+	}
+}