Initial version of RecyclableBlockList implemented.

Tests switched to xUnit in hope to avoid stability issues.
This commit is contained in:
mlemanczyk committed 2023-01-07 20:52:01 +01:00
1 parent aba28028b1
commit 93b8dc5317
17 files changed
+966 -225

No files matched your search

@@ -1,6 +1,5 @@
using BenchmarkDotNet.Attributes; using BenchmarkDotNet.Attributes;
using MiscUtil; using MiscUtil;
using MiscUtil.Extensions;
namespace Recyclable.Collections.Benchmarks namespace Recyclable.Collections.Benchmarks
{ {
@@ -5,9 +5,23 @@ namespace Recyclable.Collections.Benchmarks
[MemoryDiagnoser] [MemoryDiagnoser]
public class ListVsLinkedListBenchmark public class ListVsLinkedListBenchmark
{ {
private const int _objectCount = 1_000_000; //[Params(0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 128, 256, 512, 1024, 2048, 4096, 8192, 1_000_000)]
private const int _blockSize = 100_000; public int TestObjectCount = 1_000_000;
private static readonly object[] _testObjects = Enumerable.Range(1, _objectCount).Select(x => new object()).ToArray(); public int BlockSize => TestObjectCount switch
{
0 => 1,
> 0 and <= 10 => TestObjectCount,
_ => TestObjectCount / 10
};
private object[]? _testObjects;
public ListVsLinkedListBenchmark()
{
_ = TestObjects;
}
private object[] TestObjects => _testObjects ??= Enumerable.Range(1, TestObjectCount).Select(x => new object()).ToArray();
private static void DoNothing<T>(T obj) private static void DoNothing<T>(T obj)
{ {
@@ -17,10 +31,12 @@ namespace Recyclable.Collections.Benchmarks
[Benchmark] [Benchmark]
public void Array() public void Array()
{ {
var list = new object[_testObjects.LongLength]; var data = TestObjects;
for (var i = 0; i < _testObjects.Length; i++) var dataCount = TestObjectCount;
var list = new object[dataCount];
for (var i = 0; i < dataCount; i++)
{ {
list[i] = _testObjects[i]; list[i] = data[i];
} }
for (var i = 0; i < list.LongLength; i++) for (var i = 0; i < list.LongLength; i++)
@@ -29,18 +45,39 @@ namespace Recyclable.Collections.Benchmarks
} }
} }
[Benchmark]
public void RecyclableBlockList()
{
var data = TestObjects;
var dataCount = TestObjectCount;
using var list = new RecyclableBlockList<object>(initialCapacity: dataCount);
for (var i = 0; i < dataCount; i++)
{
list.Add(data[i]);
}
for (var i = 0; i < list.LongCount; i++)
{
DoNothing(list[i]);
}
list.Clear();
}
[Benchmark(Baseline = true)] [Benchmark(Baseline = true)]
public void RecyclableList() public void RecyclableList()
{ {
using var list = new RecyclableList<object>(_blockSize); var data = TestObjects;
for (var i = 0; i < _testObjects.LongLength; i++) var dataCount = TestObjectCount;
using var list = new RecyclableList<object>(BlockSize, initialCapacity: dataCount);
for (var i = 0; i < dataCount; i++)
{ {
list.Add(_testObjects[i]); list.Add(data[i]);
} }
for (var i = 0; i < list.Count; i++) for (var i = 0; i < list.LongCount; i++)
{ {
DoNothing(_testObjects[i]); DoNothing(list[i]);
} }
list.Clear(); list.Clear();
@@ -49,10 +86,12 @@ namespace Recyclable.Collections.Benchmarks
[Benchmark] [Benchmark]
public void List() public void List()
{ {
var list = new List<object>(); var data = TestObjects;
for (var i = 0; i < _testObjects.LongLength; i++) var dataCount = TestObjectCount;
var list = new List<object>(capacity: dataCount);
for (var i = 0; i < dataCount; i++)
{ {
list.Add(_testObjects[i]); list.Add(data[i]);
} }
for (var i = 0; i < list.Count; i++) for (var i = 0; i < list.Count; i++)
@@ -66,10 +105,12 @@ namespace Recyclable.Collections.Benchmarks
//[Benchmark] //[Benchmark]
public void LinkedList() public void LinkedList()
{ {
var data = TestObjects;
var dataCount = TestObjectCount;
var list = new LinkedList<object>(); var list = new LinkedList<object>();
for (var i = 0; i < _testObjects.LongLength; i++) for (var i = 0; i < dataCount; i++)
{ {
_ = list.AddLast(_testObjects[i]); _ = list.AddLast(data[i]);
} }
foreach (var node in list) foreach (var node in list)
@@ -80,18 +121,20 @@ namespace Recyclable.Collections.Benchmarks
list.Clear(); list.Clear();
} }
[Benchmark] //[Benchmark]
public void RecyclableQueue() public void RecyclableQueue()
{ {
var list = new RecyclableQueue<object>(_blockSize); var data = TestObjects;
for (var i = 0; i < _testObjects.LongLength; i++) var dataCount = TestObjectCount;
var list = new RecyclableQueue<object>(BlockSize);
for (var i = 0; i < dataCount; i++)
{ {
list.Enqueue(_testObjects[i]); list.Enqueue(data[i]);
} }
foreach (var node in list) while (list.LongCount > 0)
{ {
DoNothing(node); DoNothing(list.Dequeue());
} }
list.Clear(); list.Clear();
@@ -100,15 +143,17 @@ namespace Recyclable.Collections.Benchmarks
//[Benchmark] //[Benchmark]
public void Queue() public void Queue()
{ {
var list = new Queue<object>(); var data = TestObjects;
for (var i = 0; i < _testObjects.LongLength; i++) var dataCount = TestObjectCount;
var list = new Queue<object>(capacity: dataCount);
for (var i = 0; i < dataCount; i++)
{ {
list.Enqueue(_testObjects[i]); list.Enqueue(data[i]);
} }
foreach (var node in list) while (list.Count > 0)
{ {
DoNothing(node); DoNothing(list.Dequeue());
} }
list.Clear(); list.Clear();
@@ -117,16 +162,17 @@ namespace Recyclable.Collections.Benchmarks
//[Benchmark] //[Benchmark]
public void PriorityQueue() public void PriorityQueue()
{ {
var list = new PriorityQueue<object, long>(); var data = TestObjects;
for (var i = 0; i < _testObjects.LongLength; i++) var dataCount = TestObjectCount;
var list = new PriorityQueue<object, long>(initialCapacity: dataCount);
for (var i = 0; i < dataCount; i++)
{ {
list.Enqueue(_testObjects[i], i); list.Enqueue(data[i], i);
} }
while (list.Count > 0) while (list.Count > 0)
{ {
var node = list.Dequeue(); DoNothing(list.Dequeue());
DoNothing(node);
} }
list.Clear(); list.Clear();
@@ -135,18 +181,20 @@ namespace Recyclable.Collections.Benchmarks
//[Benchmark] //[Benchmark]
public void RecyclableSortedList_InUpdateMode() public void RecyclableSortedList_InUpdateMode()
{ {
var list = new RecyclableSortedList<long, object>(_blockSize); var data = TestObjects;
var dataCount = TestObjectCount;
var list = new RecyclableSortedList<long, object>(BlockSize);
list.BeginUpdate(); list.BeginUpdate();
for (var i = 0; i < _testObjects.LongLength; i++) for (var i = 0; i < dataCount; i++)
{ {
list.Add(i, _testObjects[i]); list.Add(i, data[i]);
} }
list.EndUpdate(); list.EndUpdate();
for (var i = 0; i < list.LongCount; i++) for (var i = 0; i < list.LongCount; i++)
{ {
DoNothing(_testObjects[i]); DoNothing(list[i]);
} }
list.Clear(); list.Clear();
@@ -155,15 +203,17 @@ namespace Recyclable.Collections.Benchmarks
//[Benchmark] //[Benchmark]
public void RecyclableSortedList() public void RecyclableSortedList()
{ {
var list = new RecyclableSortedList<long, object>(_blockSize); var data = TestObjects;
for (var i = 0; i < _testObjects.LongLength; i++) var dataCount = TestObjectCount;
var list = new RecyclableSortedList<long, object>(BlockSize);
for (var i = 0; i < dataCount; i++)
{ {
list.Add(i, _testObjects[i]); list.Add(i, data[i]);
} }
for (var i = 0; i < list.LongCount; i++) for (var i = 0; i < list.LongCount; i++)
{ {
DoNothing(_testObjects[i]); DoNothing(list[i]);
} }
list.Clear(); list.Clear();
@@ -172,15 +222,17 @@ namespace Recyclable.Collections.Benchmarks
//[Benchmark] //[Benchmark]
public void SortedList() public void SortedList()
{ {
var data = TestObjects;
var dataCount = TestObjectCount;
var list = new SortedList<long, object>(); var list = new SortedList<long, object>();
for (var i = 0; i < _testObjects.LongLength; i++) for (var i = 0; i < dataCount; i++)
{ {
list.Add(i, _testObjects[i]); list.Add(i, data[i]);
} }
for (var i = 0; i < list.Count; i++) for (var i = 0; i < list.Count; i++)
{ {
DoNothing(_testObjects[i]); DoNothing(list[i]);
} }
list.Clear(); list.Clear();
@@ -189,15 +241,17 @@ namespace Recyclable.Collections.Benchmarks
//[Benchmark] //[Benchmark]
public void RecyclableStack() public void RecyclableStack()
{ {
var list = new RecyclableStack<object>(_blockSize); var data = TestObjects;
for (var i = 0; i < _testObjects.LongLength; i++) var dataCount = TestObjectCount;
var list = new RecyclableStack<object>(BlockSize);
for (var i = 0; i < dataCount; i++)
{ {
list.Push(_testObjects[i]); list.Push(data[i]);
} }
foreach (var node in list) while (list.LongCount > 0)
{ {
DoNothing(node); DoNothing(list.Pop());
} }
list.Clear(); list.Clear();
@@ -206,15 +260,17 @@ namespace Recyclable.Collections.Benchmarks
//[Benchmark] //[Benchmark]
public void Stack() public void Stack()
{ {
var data = TestObjects;
var dataCount = TestObjectCount;
var list = new Stack<object>(); var list = new Stack<object>();
for (var i = 0; i < _testObjects.LongLength; i++) for (var i = 0; i < dataCount; i++)
{ {
list.Push(_testObjects[i]); list.Push(data[i]);
} }
foreach (var node in list) while (list.Count > 0)
{ {
DoNothing(node); DoNothing(list.Pop());
} }
list.Clear(); list.Clear();
+1 -1
View File
@@ -5,4 +5,4 @@ BenchmarkRunner.Run<ListVsLinkedListBenchmark>();
//BenchmarkRunner.Run<DelegateVsComparerBenchmark>(); //BenchmarkRunner.Run<DelegateVsComparerBenchmark>();
//var tests = new ListVsLinkedListBenchmark(); //var tests = new ListVsLinkedListBenchmark();
//tests.RecyclableList(); //tests.RecyclableBlockList();
+93
View File
@@ -6,6 +6,79 @@ namespace Recyclable.Collections
// It was only beautified for .Net 6.0+. // It was only beautified for .Net 6.0+.
public static class ListExtensions public static class ListExtensions
{ {
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool Contains<T>(this RecyclableBlockList<T[]> arrays, T item) => arrays.Any(x => x.Contains(item));
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void CopyTo<T>(this RecyclableBlockList<T[]> arrays, long startingIndex, int blockSize, int lastBlockSize, T[] destinationArray, int destinationArrayIndex)
{
Span<T> arrayMemory = destinationArray.AsSpan();
arrayMemory = arrayMemory[destinationArrayIndex..];
int startingArrayIndex = (int)(startingIndex / blockSize);
startingIndex %= blockSize;
if (arrays.Count > 0)
{
ReadOnlySpan<T> sourceMemory = arrays[0].AsSpan();
var maxToCopy = (int)Math.Min(blockSize - startingIndex, arrayMemory.Length);
if (arrays.Count == 1)
{
maxToCopy = (int)Math.Min(maxToCopy, lastBlockSize);
}
sourceMemory = sourceMemory[(int)startingIndex..maxToCopy];
sourceMemory.CopyTo(arrayMemory);
arrayMemory = arrayMemory[maxToCopy..];
}
for (var arrayIdx = startingArrayIndex + 1; arrayIdx < arrays.Count - 1 && arrayMemory.Length > 0; arrayIdx++)
{
ReadOnlySpan<T> sourceMemory = arrays[arrayIdx].AsSpan();
var maxToCopy = Math.Min(blockSize, arrayMemory.Length);
sourceMemory = sourceMemory[..maxToCopy];
sourceMemory.CopyTo(arrayMemory);
arrayMemory = arrayMemory[maxToCopy..];
}
if (arrays.Count > 1 && arrayMemory.Length > 0)
{
ReadOnlySpan<T> sourceMemory = arrays[^1].AsSpan();
var maxToCopy = Math.Min(lastBlockSize, arrayMemory.Length);
sourceMemory = sourceMemory[..maxToCopy];
sourceMemory.CopyTo(arrayMemory);
}
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static IEnumerable<T> Enumerate<T>(this RecyclableBlockList<T[]> arrays, int chunkSize, long totalCount)
{
long currentCount = 0;
for (var arrayIdx = 0; (arrayIdx < arrays.Count) && (currentCount < totalCount); arrayIdx++)
{
var array = arrays[arrayIdx];
currentCount += Math.Min(chunkSize, totalCount);
switch (currentCount < totalCount)
{
case true:
for (var valueIdx = 0; valueIdx < chunkSize; valueIdx++)
{
yield return array[valueIdx];
}
break;
case false:
var partialCount = (int)(totalCount % chunkSize);
int maxCount = partialCount > 0 ? partialCount : chunkSize;
for (var valueIdx = 0; valueIdx < maxCount; valueIdx++)
{
yield return array[valueIdx];
}
break;
}
}
}
public static void InsertionSort<T>(this IList<T> values, int startIndex, int endIndex, IComparer<T> comparer) public static void InsertionSort<T>(this IList<T> values, int startIndex, int endIndex, IComparer<T> comparer)
{ {
var left = startIndex; var left = startIndex;
@@ -29,6 +102,26 @@ namespace Recyclable.Collections
{ {
values.InsertionSort(Comparer<T>.Default); values.InsertionSort(Comparer<T>.Default);
} }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static long LongIndexOf<T>(this RecyclableBlockList<T[]> arrays, int blockSize, T item, IEqualityComparer<T> comparer)
{
for (var arrayIdx = 0; arrayIdx < arrays.Count; arrayIdx++)
{
var array = arrays[arrayIdx];
Span<T> arrayMemory = array.AsSpan();
for (int memoryIdx = 0; memoryIdx < arrayMemory.Length; memoryIdx++)
{
if (comparer.Equals(arrayMemory[memoryIdx], item))
{
return (arrayIdx * (long)blockSize) + memoryIdx;
}
}
}
return -1;
}
public static void QuickSort<T>(this IList<T> values, int startIndex, int endIndex, IComparer<T> comparer, IRandomNumberGenerator randomNumberGenerator) public static void QuickSort<T>(this IList<T> values, int startIndex, int endIndex, IComparer<T> comparer, IRandomNumberGenerator randomNumberGenerator)
{ {
var range = (startIndex, endIndex); var range = (startIndex, endIndex);
@@ -7,7 +7,7 @@
<Nullable>enable</Nullable> <Nullable>enable</Nullable>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild> <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<PackageId>Recyclable.Collections</PackageId> <PackageId>Recyclable.Collections</PackageId>
<PackageVersion>0.0.2</PackageVersion> <PackageVersion>0.0.3</PackageVersion>
<Authors>Marek Lemańczyk</Authors> <Authors>Marek Lemańczyk</Authors>
<Company>N/A</Company> <Company>N/A</Company>
<Product>Recyclable.Collections</Product> <Product>Recyclable.Collections</Product>
@@ -0,0 +1,334 @@
using System.Collections;
using System.Runtime.CompilerServices;
namespace Recyclable.Collections
{
public class RecyclableBlockList<T> : IEnumerable<T>, IDisposable
{
private static readonly IEqualityComparer<T> _equalityComparer = EqualityComparer<T>.Default;
private bool _disposedValue;
private void CopyItems(long startingIndex, long count, ref T[] destArray, long offset = 1)
{
for (long destItemIndex = startingIndex, sourceItemIndex = offset; destItemIndex < startingIndex + count; destItemIndex++, sourceItemIndex++)
{
destArray[destItemIndex] = _memory[sourceItemIndex];
}
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static T GetItem(in T[] arrays, in long index) => arrays[index];
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private void InternalRemoveAt(long index)
{
long oldCount = LongCount;
long oldCountMinus1 = oldCount - 1;
if (index == oldCountMinus1)
{
LongCount--;
return;
}
if (index >= oldCount)
{
throw new ArgumentOutOfRangeException(nameof(index));
}
CopyItems(index, oldCountMinus1, ref _memory);
LongCount--;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static long LongIndexOf(in T[] memory, in long itemCount, T? itemToFind, IEqualityComparer<T> equalityComparer)
{
for (var itemIdx = 0; itemIdx < itemCount; itemIdx++)
{
var item = memory[itemIdx];
if (equalityComparer.Equals(item, itemToFind))
{
return itemIdx;
}
}
return -1;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static void SetItem(in T[] arrays, in long index, in T value) => arrays[index] = value;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private T[] SetNewLength(long newSize)
{
var source = _memory;
T[] newArray = newSize.RentArrayFromPool<T>();
if (newArray.LongLength >= source.LongLength)
{
source.CopyTo(newArray, 0);
}
else
{
CopyItems(0, newArray.LongLength, ref newArray, 0);
}
source.ReturnToPool();
return newArray;
}
protected T[] _memory = Array.Empty<T>();
public RecyclableBlockList(long initialCapacity = RecyclableDefaults.Capacity)
{
//EnsureCapacity(capacity);
if (_capacity < initialCapacity)
{
long newCapacity;
switch (_capacity > 0)
{
case true:
newCapacity = _capacity * 2;
while (newCapacity < initialCapacity)
{
newCapacity *= 2;
}
break;
case false:
newCapacity = initialCapacity;
break;
}
_capacity = newCapacity;
_memory = SetNewLength(newCapacity);
}
}
public RecyclableBlockList(IEnumerable<T> source, int initialCapacity = RecyclableDefaults.Capacity)
{
//EnsureCapacity(capacity);
if (_capacity < initialCapacity)
{
long newCapacity;
switch (_capacity > 0)
{
case true:
newCapacity = _capacity * 2;
while (newCapacity < initialCapacity)
{
newCapacity *= 2;
}
break;
case false:
newCapacity = initialCapacity;
break;
}
_capacity = newCapacity;
_memory = SetNewLength(newCapacity);
}
foreach (var item in source)
{
Add(item);
}
}
public T this[long index]
{
get => GetItem(_memory, index);
set => SetItem(_memory, index, value);
}
public T this[int index]
{
get => GetItem(_memory, index);
set => SetItem(_memory, index, value);
}
private long _capacity;
public long Capacity
{
get => _capacity;
set
{
if (_capacity != value)
{
_memory = SetNewLength(value);
_capacity = value;
}
}
}
public int Count => (int)LongCount;
public long LongCount { get; set; }
public bool IsReadOnly { get; } = false;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public void Add(in T item)
{
//EnsureCapacity(LongCount + 1);
long requestedCapacity = LongCount + 1;
if (_capacity < requestedCapacity)
{
long newCapacity;
switch (_capacity > 0)
{
case true:
newCapacity = _capacity * 2;
while (newCapacity < requestedCapacity)
{
newCapacity *= 2;
}
break;
case false:
newCapacity = requestedCapacity;
break;
}
_capacity = newCapacity;
_memory = SetNewLength(newCapacity);
}
_memory[LongCount] = item;
LongCount++;
}
//[MethodImpl(MethodImplOptions.AggressiveInlining)]
//public void EnsureCapacity(long requestedCapacity)
//{
// if (Capacity < requestedCapacity)
// {
// long newCapacity;
// switch (Capacity > 0)
// {
// case true:
// newCapacity = Capacity * 2;
// while (newCapacity < requestedCapacity)
// {
// newCapacity *= 2;
// }
// break;
// case false:
// newCapacity = requestedCapacity;
// break;
// }
// _capacity = newCapacity;
// _memory = SetNewLength(newCapacity);
// }
//}
public void Clear()
{
LongCount = 0;
}
public bool Contains(T item) => _memory.Contains(item);
public void CopyTo(T[] array, int arrayIndex) => _memory.CopyTo(array, arrayIndex);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public IEnumerable<T> Enumerate()
{
for (var i = 0; i < LongCount; i++)
{
yield return _memory[i];
}
}
public int IndexOf(T item) => (int)LongIndexOf(_memory, LongCount, item, _equalityComparer);
public void Insert(int index, T item)
{
long requestedCapacity = LongCount + 1;
if (Capacity < requestedCapacity)
{
long newCapacity;
switch (Capacity > 0)
{
case true:
newCapacity = Capacity * 2;
while (newCapacity < requestedCapacity)
{
newCapacity *= 2;
}
break;
case false:
newCapacity = requestedCapacity;
break;
}
_capacity = newCapacity;
_memory = SetNewLength(newCapacity);
}
for (var toMoveIdx = LongCount - 1; toMoveIdx >= index; toMoveIdx--)
{
_memory[toMoveIdx + 1] = _memory[toMoveIdx];
}
_memory[index] = item;
LongCount++;
}
public long LongIndexOf(T item) => LongIndexOf(_memory, LongCount, item, _equalityComparer);
public bool Remove(T item)
{
var itemIdx = LongIndexOf(item);
if (itemIdx >= 0)
{
RemoveAt(itemIdx);
return true;
}
return false;
}
public void RemoveAt(int index) => InternalRemoveAt(index);
public void RemoveAt(long index) => InternalRemoveAt(index);
public IEnumerator<T> GetEnumerator() => Enumerate().GetEnumerator();
IEnumerator IEnumerable.GetEnumerator() => Enumerate().GetEnumerator();
protected virtual void Dispose(bool disposing)
{
if (!_disposedValue)
{
if (disposing)
{
Clear();
_memory.ReturnToPool();
Capacity = 0;
}
_disposedValue = true;
}
}
// override finalizer only if 'Dispose(bool disposing)' has code to free unmanaged resources
// ~RecyclableList()
// {
// // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
// Dispose(disposing: false);
// }
public void Dispose()
{
// Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
Dispose(disposing: true);
GC.SuppressFinalize(this);
}
}
}
@@ -3,5 +3,6 @@
public class RecyclableDefaults public class RecyclableDefaults
{ {
public const int BlockSize = 10_240; public const int BlockSize = 10_240;
public const int Capacity = 8;
} }
} }
+70 -26
View File
@@ -7,17 +7,38 @@ namespace Recyclable.Collections
{ {
private static readonly IEqualityComparer<T> _equalityComparer = EqualityComparer<T>.Default; private static readonly IEqualityComparer<T> _equalityComparer = EqualityComparer<T>.Default;
private readonly List<T[]> _arrays = new(); private readonly RecyclableBlockList<T[]> _memoryBlocks;
private bool _disposedValue; private bool _disposedValue;
public RecyclableList(int blockSize = RecyclableDefaults.BlockSize) public RecyclableList(int blockSize = RecyclableDefaults.BlockSize, long? initialCapacity = default)
{ {
BlockSize = blockSize; BlockSize = blockSize;
initialCapacity ??= 8 * BlockSize;
int additionalArray = initialCapacity % BlockSize > 0 ? 1 : 0;
long targetCapacity = (initialCapacity.Value / BlockSize) + additionalArray;
_memoryBlocks = new(targetCapacity);
Capacity = initialCapacity.Value;
for (var blockIdx = 0; blockIdx < targetCapacity; blockIdx++)
{
_memoryBlocks.Add(BlockSize.RentArrayFromPool<T>());
} }
public RecyclableList(IEnumerable<T> source, int blockSize = RecyclableDefaults.BlockSize) //MemoryBlocks.LongCount = MemoryBlocks.Capacity;
}
public RecyclableList(IEnumerable<T> source, int blockSize = RecyclableDefaults.BlockSize, long? initialCapacity = default)
{ {
BlockSize = blockSize; BlockSize = blockSize;
initialCapacity ??= 8 * BlockSize;
int additionalCapacity = initialCapacity % BlockSize > 0 ? 1 : 0;
long targetCapacity = (initialCapacity.Value / BlockSize) + additionalCapacity;
_memoryBlocks = new(targetCapacity);
Capacity = initialCapacity.Value;
for (var blockIdx = 0; blockIdx < targetCapacity; blockIdx++)
{
_memoryBlocks.Add(BlockSize.RentArrayFromPool<T>());
}
foreach (var item in source) foreach (var item in source)
{ {
Add(item); Add(item);
@@ -27,42 +48,47 @@ namespace Recyclable.Collections
public int BlockSize { get; } public int BlockSize { get; }
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void SetItem(List<T[]> arrays, in int blockSize, in long index, in T value) public static void SetItem(RecyclableBlockList<T[]> arrays, in int blockSize, in long index, in T value)
=> arrays[(int)(index / blockSize)][index % blockSize] = value; => arrays[(int)(index / blockSize)][index % blockSize] = value;
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public static T GetItem(List<T[]> arrays, in int blockSize, in long index) public static T GetItem(RecyclableBlockList<T[]> arrays, in int blockSize, in long index)
=> arrays[(int)(index / blockSize)][index % blockSize]; => arrays[(int)(index / blockSize)][index % blockSize];
public T this[long index] public T this[long index]
{ {
get => GetItem(_arrays, BlockSize, index); //get => GetItem(MemoryBlocks, BlockSize, index);
set => SetItem(_arrays, BlockSize, index, value); //set => SetItem(MemoryBlocks, BlockSize, index, value);
get => _memoryBlocks[(int)(index / BlockSize)][index % BlockSize];
set => _memoryBlocks[(int)(index / BlockSize)][index % BlockSize] = value;
} }
public T this[int index] public T this[int index]
{ {
get => GetItem(_arrays, BlockSize, index); //get => GetItem(MemoryBlocks, BlockSize, index);
set => SetItem(_arrays, BlockSize, index, value); //set => SetItem(MemoryBlocks, BlockSize, index, value);
get => _memoryBlocks[(int)(index / BlockSize)][index % BlockSize];
set => _memoryBlocks[(int)(index / BlockSize)][index % BlockSize] = value;
} }
public long Capacity { get; set; } public long Capacity { get; set; }
public int Count => (int)LongCount; public int Count => (int)LongCount;
public long LongCount { get; set; } public long LongCount { get; set; }
public bool IsReadOnly { get; } = false; public bool IsReadOnly { get; } = false;
public int BlockCount => _arrays.Count; public long BlockCount => _memoryBlocks.LongCount;
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public void Add(T item) public void Add(T item)
{ {
if (LongCount == Capacity) if (LongCount == Capacity)
{ {
T[] newArray = BlockSize.RentArrayFromPool<T>(); T[] newMemoryBlock = BlockSize.RentArrayFromPool<T>();
_arrays.Add(newArray); _memoryBlocks.Add(newMemoryBlock);
Capacity += BlockSize; Capacity += BlockSize;
} }
this[LongCount] = item; SetItem(_memoryBlocks, BlockSize, LongCount, item);
//_arrays[_arrays.LongCount - 1][LongCount % BlockSize] = item;
LongCount++; LongCount++;
} }
@@ -71,11 +97,11 @@ namespace Recyclable.Collections
try try
{ {
// Remove in reversed order for performance savings // Remove in reversed order for performance savings
while (_arrays.Count > 0) while (_memoryBlocks.Count > 0)
{ {
try try
{ {
RemoveBlock(_arrays.Count - 1); RemoveBlock(_memoryBlocks.Count - 1);
} }
catch (Exception) catch (Exception)
{ {
@@ -87,29 +113,47 @@ namespace Recyclable.Collections
finally finally
{ {
LongCount = 0; LongCount = 0;
_arrays.Clear(); _memoryBlocks.Clear();
} }
} }
public bool Contains(T item) => _arrays.Contains(item); public bool Contains(T item) => _memoryBlocks.Contains(item);
public void CopyTo(T[] array, int arrayIndex) => _arrays.CopyTo(0, BlockSize, (int)LongCount % BlockSize, array, arrayIndex); public void CopyTo(T[] array, int arrayIndex) => _memoryBlocks.CopyTo(0, BlockSize, (int)LongCount % BlockSize, array, arrayIndex);
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public IEnumerator<T> GetEnumerator() => _arrays.Enumerate(BlockSize, LongCount).GetEnumerator(); public IEnumerator<T> GetEnumerator() => _memoryBlocks.Enumerate(BlockSize, LongCount).GetEnumerator();
public int IndexOf(T item) => (int)_arrays.LongIndexOf(BlockSize, item, _equalityComparer); public int IndexOf(T item) => (int)_memoryBlocks.LongIndexOf(BlockSize, item, _equalityComparer);
public void Insert(int index, T item) => throw new NotSupportedException(); public void Insert(int index, T item) => throw new NotSupportedException();
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public long LongIndexOf(T item) => _arrays.LongIndexOf(BlockSize, item, _equalityComparer); public long LongIndexOf(T item) => _memoryBlocks.LongIndexOf(BlockSize, item, _equalityComparer);
public bool Remove(T item) => throw new NotSupportedException(); public bool Remove(T item) => throw new NotSupportedException();
public void RemoveAt(int index) => throw new NotSupportedException(); public void RemoveAt(int index) => RemoveAt(this, index);
public void RemoveAt(long index) => RemoveAt(this, index);
IEnumerator IEnumerable.GetEnumerator() => _arrays.Enumerate(BlockSize, LongCount).GetEnumerator(); [MethodImpl(MethodImplOptions.AggressiveInlining)]
private static void RemoveAt(RecyclableList<T> list, long index)
{
if (index == list.LongCount - 1)
{
list.LongCount--;
if (list.Capacity - list.LongCount == list.BlockSize)
{
list.RemoveBlock(list.BlockCount - 1);
}
}
else
{
throw new NotSupportedException("Only removal of the last element is supported");
}
}
IEnumerator IEnumerable.GetEnumerator() => _memoryBlocks.Enumerate(BlockSize, LongCount).GetEnumerator();
protected virtual void Dispose(bool disposing) protected virtual void Dispose(bool disposing)
{ {
@@ -138,12 +182,12 @@ namespace Recyclable.Collections
GC.SuppressFinalize(this); GC.SuppressFinalize(this);
} }
public void RemoveBlock(int index) public void RemoveBlock(long index)
{ {
try try
{ {
_arrays[index].ReturnToPool(); _memoryBlocks[index].ReturnToPool();
_arrays.RemoveAt(index); _memoryBlocks.RemoveAt(index);
} }
finally finally
{ {
@@ -1,12 +1,15 @@
using System.Buffers; using System.Buffers;
using System.Buffers;
using System.Runtime.CompilerServices; using System.Runtime.CompilerServices;
namespace Recyclable.Collections namespace Recyclable.Collections
{ {
public static class RecyclableListExtensions public static class RecyclableListExtensions
{ {
private const int _minPooledArraySize = 100;
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void CopyTo<T>(this List<T[]> arrays, long startingIndex, int blockSize, int lastBlockSize, T[] destinationArray, int destinationArrayIndex) public static void CopyTo<T>(this RecyclableList<T[]> arrays, long startingIndex, int blockSize, int lastBlockSize, T[] destinationArray, int destinationArrayIndex)
{ {
Span<T> arrayMemory = destinationArray.AsSpan(); Span<T> arrayMemory = destinationArray.AsSpan();
arrayMemory = arrayMemory[destinationArrayIndex..]; arrayMemory = arrayMemory[destinationArrayIndex..];
@@ -45,10 +48,10 @@ namespace Recyclable.Collections
} }
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool Contains<T>(this List<T[]> arrays, T item) => arrays.Any(x => x.Contains(item)); public static bool Contains<T>(this RecyclableList<T[]> arrays, T item) => arrays.Any(x => x.Contains(item));
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public static IEnumerable<T> Enumerate<T>(this List<T[]> arrays, int chunkSize, long totalCount) public static IEnumerable<T> Enumerate<T>(this RecyclableList<T[]> arrays, int chunkSize, long totalCount)
{ {
long currentCount = 0; long currentCount = 0;
for (var arrayIdx = 0; arrayIdx < arrays.Count; arrayIdx++) for (var arrayIdx = 0; arrayIdx < arrays.Count; arrayIdx++)
@@ -83,7 +86,7 @@ namespace Recyclable.Collections
=> comparer.Compare(value, maxValue) > 0 ? maxValue : value; => comparer.Compare(value, maxValue) > 0 ? maxValue : value;
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public static long LongIndexOf<T>(this List<T[]> arrays, int blockSize, T item, IEqualityComparer<T> comparer) public static long LongIndexOf<T>(this RecyclableList<T[]> arrays, int blockSize, T item, IEqualityComparer<T> comparer)
{ {
for (var arrayIdx = 0; arrayIdx < arrays.Count; arrayIdx++) for (var arrayIdx = 0; arrayIdx < arrays.Count; arrayIdx++)
{ {
@@ -101,12 +104,6 @@ namespace Recyclable.Collections
return -1; return -1;
} }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static int ToArrayIndex(this long index, int blockSize) => (int)(index / blockSize);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static long ToItemIndex(this long index, int blockSize) => index % blockSize;
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public static RecyclableList<T> ToRecyclableList<T>(this IList<T> values, int blockSize = RecyclableDefaults.BlockSize) => new(values, blockSize); public static RecyclableList<T> ToRecyclableList<T>(this IList<T> values, int blockSize = RecyclableDefaults.BlockSize) => new(values, blockSize);
@@ -114,18 +111,27 @@ namespace Recyclable.Collections
public static RecyclableList<T> ToRecyclableList<T>(this IEnumerable<T> values, int blockSize = RecyclableDefaults.BlockSize) => new(values, blockSize); public static RecyclableList<T> ToRecyclableList<T>(this IEnumerable<T> values, int blockSize = RecyclableDefaults.BlockSize) => new(values, blockSize);
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public static T[] RentArrayFromPool<T>(this int minSize) => ArrayPool<T>.Shared.Rent(minSize); public static T[] RentArrayFromPool<T>(this int minSize) => RentArrayFromPool<T>((long)minSize);
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void ReturnToPool<T>(this T[] array) => ArrayPool<T>.Shared.Return(array); public static T[] RentArrayFromPool<T>(this long minSize)
{
return minSize switch
{
< _minPooledArraySize => new T[minSize],
<= int.MaxValue => ArrayPool<T>.Shared.Rent((int)minSize),
_ => new T[minSize]
};
}
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void SetItem<T>(this List<T[]> arrays, in int blockSize, in long index, in T value) public static void ReturnToPool<T>(this T[] array)
=> arrays[(int)(index / blockSize)][index % blockSize] = value; {
long arrayLength = array.LongLength;
[MethodImpl(MethodImplOptions.AggressiveInlining)] if (arrayLength is >= _minPooledArraySize and <= int.MaxValue)
public static T GetItem<T>(this List<T[]> arrays, in int blockSize, in long index) {
=> arrays[(int)(index / blockSize)][index % blockSize]; ArrayPool<T>.Shared.Return(array);
}
}
} }
} }
+94 -74
View File
@@ -1,5 +1,4 @@
using System.Buffers; using System.Collections;
using System.Collections;
using System.Runtime.CompilerServices; using System.Runtime.CompilerServices;
namespace Recyclable.Collections namespace Recyclable.Collections
@@ -7,25 +6,55 @@ namespace Recyclable.Collections
public class RecyclableQueue<T> : IRecyclableOwner<T>, IList<T>, IDisposable public class RecyclableQueue<T> : IRecyclableOwner<T>, IList<T>, IDisposable
{ {
private static readonly IEqualityComparer<T> _equalityComparer = EqualityComparer<T>.Default; private static readonly IEqualityComparer<T> _equalityComparer = EqualityComparer<T>.Default;
private static readonly IComparer<long> _comparer = Comparer<long>.Default;
private bool _disposedValue; private bool _disposedValue;
private RecyclableBlockList<T[]> Memory { get; }
protected List<T[]> Arrays { get; } [MethodImpl(MethodImplOptions.AggressiveInlining)]
protected long GetAbsoluteIndex(long index) => index + RemovedCount; private static T Dequeue(RecyclableQueue<T> queue)
{
if (queue.LongCount <= 0)
{
throw new ArgumentOutOfRangeException(nameof(queue), "There are no items in the queue");
}
var toRemove = queue[0];
queue.RemovedCount++;
queue.LongCount--;
if (queue.Capacity - queue.LongCount == queue.BlockSize)
{
queue.RemoveBlock(0);
queue.RemovedCount -= queue.BlockSize;
}
return toRemove;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static bool TryDequeue(RecyclableQueue<T> queue, out T? item)
{
if (queue.LongCount > 0)
{
item = queue.Dequeue();
return true;
}
item = default;
return false;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected static long GetAbsoluteIndex(long index, long removedCount) => index + removedCount;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected long GetRelativeIndex(long index) => index - RemovedCount; protected long GetRelativeIndex(long index) => index - RemovedCount;
protected long RemovedCount { get; set; } protected long RemovedCount { get; set; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static T[] RentArrayFromPool(int minSize) => ArrayPool<T>.Shared.Rent(minSize);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void ReturnToPool(T[] array) => ArrayPool<T>.Shared.Return(array);
public RecyclableQueue(IEnumerable<T> source, int blockSize = RecyclableDefaults.BlockSize) public RecyclableQueue(IEnumerable<T> source, int blockSize = RecyclableDefaults.BlockSize)
{ {
BlockSize = blockSize; BlockSize = blockSize;
Arrays = new(); Memory = new(1);
foreach (var item in source) foreach (var item in source)
{ {
Enqueue(item); Enqueue(item);
@@ -35,7 +64,7 @@ namespace Recyclable.Collections
public RecyclableQueue(int blockSize = RecyclableDefaults.BlockSize) public RecyclableQueue(int blockSize = RecyclableDefaults.BlockSize)
{ {
BlockSize = blockSize; BlockSize = blockSize;
Arrays = new(); Memory = new(1);
} }
public int BlockSize { get; protected set; } public int BlockSize { get; protected set; }
@@ -43,31 +72,47 @@ namespace Recyclable.Collections
public int Count public int Count
{ {
get => (int)LongCount.LimitTo(int.MaxValue, _comparer); get => (int)LongCount;
set => LongCount = value; set => LongCount = value;
} }
public long LongCount { get; set; } public long LongCount { get; set; }
public bool IsReadOnly { get; } = false; public bool IsReadOnly { get; } = false;
public T this[int index] { get => this[(long)index]; set => this[(long)index] = value; } public T this[int index]
public T this[long index]
{ {
get get => GetItem(index);
{ set => SetItem(index, value);
long absoluteIndex = GetAbsoluteIndex(index);
int arrayIndex = absoluteIndex.ToArrayIndex(BlockSize);
long itemIndex = absoluteIndex.ToItemIndex(BlockSize);
return Arrays[arrayIndex][itemIndex];
} }
set public T this[long index]
{ {
long absoluteIndex = GetAbsoluteIndex(index); get => GetItem(index);
int arrayIndex = absoluteIndex.ToArrayIndex(BlockSize); set => SetItem(index, value);
long itemIndex = absoluteIndex.ToItemIndex(BlockSize);
Arrays[arrayIndex][itemIndex] = value;
} }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static int ToArrayIndex(long index, int blockSize) => (int)(index / blockSize);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static long ToItemIndex(long index, int blockSize) => index % blockSize;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private void SetItem(long index, T value)
{
long absoluteIndex = GetAbsoluteIndex(index, RemovedCount);
int arrayIndex = ToArrayIndex(absoluteIndex, BlockSize);
long itemIndex = ToItemIndex(absoluteIndex, BlockSize);
Memory[arrayIndex][itemIndex] = value;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private T GetItem(long index)
{
long absoluteIndex = GetAbsoluteIndex(index, RemovedCount);
int arrayIndex = ToArrayIndex(absoluteIndex, BlockSize);
long itemIndex = ToItemIndex(absoluteIndex, BlockSize);
return Memory[arrayIndex][itemIndex];
} }
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
@@ -75,32 +120,21 @@ namespace Recyclable.Collections
{ {
if (LongCount == Capacity) if (LongCount == Capacity)
{ {
T[] newArray = BlockSize.RentArrayFromPool<T>(); AddBlock();
Arrays.Add(newArray);
Capacity += BlockSize;
} }
var newIndex = LongCount; SetItem(LongCount, item);
// We don't want this[newIndex] set to raise the update event, because
// the count would be wrong. We need to increase it, first.
this[newIndex] = item;
LongCount++; LongCount++;
} }
public void AddBlock()
public T Dequeue()
{ {
var toRemove = this[0]; T[] newArray = BlockSize.RentArrayFromPool<T>();
RemovedCount++; Memory.Add(newArray);
LongCount--; Capacity += BlockSize;
if (Capacity - LongCount == BlockSize)
{
RemoveBlock(0);
RemovedCount -= BlockSize;
} }
return toRemove; public T Dequeue() => Dequeue(this);
}
public void Add(T item) => Enqueue(item); public void Add(T item) => Enqueue(item);
@@ -109,11 +143,11 @@ namespace Recyclable.Collections
try try
{ {
// Remove in reversed order for performance savings // Remove in reversed order for performance savings
while (Arrays.Count > 0) while (Memory.Count > 0)
{ {
try try
{ {
RemoveBlock(Arrays.Count - 1); RemoveBlock(Memory.Count - 1);
} }
catch (Exception) catch (Exception)
{ {
@@ -126,46 +160,32 @@ namespace Recyclable.Collections
{ {
LongCount = 0; LongCount = 0;
RemovedCount = 0; RemovedCount = 0;
Arrays.Clear(); Memory.Clear();
} }
} }
public bool Contains(T item) => Arrays.Contains(item); public bool Contains(T item) => Memory.Contains(item);
public void CopyTo(T[] array, int arrayIndex) => Arrays.CopyTo(RemovedCount, BlockSize, (int)(LongCount % BlockSize), array, arrayIndex); public void CopyTo(T[] array, int arrayIndex) => Memory.CopyTo(RemovedCount, BlockSize, (int)(LongCount % BlockSize), array, arrayIndex);
public IEnumerable<T> Enumerate() => Memory.Enumerate(BlockSize, LongCount);
[MethodImpl(MethodImplOptions.AggressiveInlining)] public IEnumerator<T> GetEnumerator() => Memory.Enumerate(BlockSize, LongCount).GetEnumerator();
public IEnumerable<T> Enumerate() => Arrays.Enumerate(BlockSize, LongCount); IEnumerator IEnumerable.GetEnumerator() => Memory.Enumerate(BlockSize, LongCount).GetEnumerator();
public IEnumerator<T> GetEnumerator() => Enumerate().GetEnumerator(); public int IndexOf(T item) => (int)LongIndexOf(item);
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator(); public long LongIndexOf(T item) => GetRelativeIndex(Memory.LongIndexOf(BlockSize, item, _equalityComparer));
public int IndexOf(T item) => (int)LongIndexOf(item).LimitTo(int.MaxValue, _comparer);
public long LongIndexOf(T item) => GetRelativeIndex(Arrays.LongIndexOf(BlockSize, item, _equalityComparer));
public void Insert(int index, T item) => throw new NotSupportedException(); public void Insert(int index, T item) => throw new NotSupportedException();
public void RemoveAt(int index) => throw new NotSupportedException(); public void RemoveAt(int index) => throw new NotSupportedException();
public bool TryDequeue(out T? item) => TryDequeue(this, out item);
public bool TryDequeue(out T? item) public bool Remove(T item) => TryDequeue(out var _);
{
if (LongCount > 0)
{
item = Dequeue();
return true;
}
item = default;
return false;
}
public bool Remove(T item) => throw new NotSupportedException();
public void RemoveBlock(int index) public void RemoveBlock(int index)
{ {
try try
{ {
ReturnToPool(Arrays[index]); Memory[index].ReturnToPool();
Arrays.RemoveAt(index); Memory.RemoveAt(index);
} }
finally finally
{ {
Capacity -= BlockSize; Capacity -= BlockSize;
LongCount -= BlockSize; //LongCount -= BlockSize;
} }
} }
@@ -11,12 +11,16 @@
<ItemGroup> <ItemGroup>
<PackageReference Include="FluentAssertions" Version="6.8.0" /> <PackageReference Include="FluentAssertions" Version="6.8.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" /> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
<PackageReference Include="MSTest.TestAdapter" Version="3.0.2" /> <PackageReference Include="morelinq" Version="3.3.2" />
<PackageReference Include="MSTest.TestFramework" Version="3.0.2" />
<PackageReference Include="coverlet.collector" Version="3.2.0"> <PackageReference Include="coverlet.collector" Version="3.2.0">
<PrivateAssets>all</PrivateAssets> <PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference> </PackageReference>
<PackageReference Include="xunit" Version="2.4.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
@@ -0,0 +1,191 @@
using FluentAssertions;
using Recyclable.Collections;
namespace Recyclable.CollectionsTests
{
public class RecyclableBlockListTests
{
private readonly static IEnumerable<int> _testData = Enumerable.Range(1, 20);
[Fact]
public void AddCountShouldSucceed()
{
// Prepare
var testData = _testData.ToArray();
var list = new RecyclableBlockList<int>();
// Act
foreach (var item in testData)
{
list.Add(item);
_ = list.LongCount.Should().Be(item);
}
// Validate
_ = list.Capacity.Should().Be(32);
_ = list.Should().HaveCount(testData.Length)
.And.ContainInConsecutiveOrder(testData)
.And.BeEquivalentTo(testData);
}
[Fact]
public void InsertAtTheBeginningShouldMoveItems()
{
// Prepare
var testData = _testData.ToArray();
var list = new RecyclableBlockList<int>();
// Act
foreach (var item in testData)
{
list.Insert(0, item);
_ = list.LongCount.Should().Be(item);
}
// Validate
_ = list.Capacity.Should().Be(32);
_ = list.Should().HaveCount(testData.Length)
.And.ContainInConsecutiveOrder(testData.Reverse())
.And.BeEquivalentTo(testData);
}
[Fact]
public void LongIndexOfShouldReturnCorrectIndexes()
{
// Prepare
var testData = _testData.ToArray();
var list = new RecyclableBlockList<int>(testData);
// Act & Validate
foreach (var item in testData)
{
// Act
var index = list.IndexOf(item);
// Validate
_ = index.Should().Be(item - 1);
}
}
[Fact]
public void RemoveFromTheBeginningShouldRemoveTheCorrectItem()
{
// Prepare
var testData = _testData.ToArray();
var list = new RecyclableBlockList<int>(testData);
// Act & Validate
for (var deleted = 1; deleted <= testData.LongLength; deleted++)
{
// Act
_ = list.Remove(deleted).Should().BeTrue();
// Validate
_ = list.Should().HaveCount(testData.Length - deleted)
.And.ContainInConsecutiveOrder(testData.Skip(deleted))
.And.BeEquivalentTo(testData.Skip(deleted));
}
}
[Fact]
public void RemoveFromTheEndShouldRemoveTheCorrectItem()
{
// Prepare
var testData = _testData.ToArray();
// Act & Validate
var list = new RecyclableBlockList<int>(testData);
for (var deleted = 1; deleted <= testData.LongLength; deleted++)
{
// Act
_ = list.Remove(testData[^deleted]).Should().BeTrue();
// Validate
_ = list.Should().HaveCount(testData.Length - deleted)
.And.ContainInConsecutiveOrder(testData.Take(testData.Length - deleted))
.And.BeEquivalentTo(testData.Take(testData.Length - deleted));
}
}
[Fact]
public void RemoveAtFromTheBeginningShouldSucceed()
{
// Prepare
var testData = _testData.ToArray();
var list = new RecyclableBlockList<int>(testData);
// Act & Validate
for (var deleted = 1; deleted <= testData.LongLength; deleted++)
{
// Act
list.RemoveAt(0);
// Validate
_ = list.Should().HaveCount(testData.Length - deleted)
.And.ContainInConsecutiveOrder(testData.Skip(deleted))
.And.BeEquivalentTo(testData.Skip(deleted));
}
_ = list.Should().BeEmpty();
_ = list.Capacity.Should().Be(32);
}
[Fact]
public void RemoveAtFromTheEndShouldSucceed()
{
// Prepare
var testData = _testData.ToArray();
var list = new RecyclableBlockList<int>(testData);
// Act & Validate
for (var deleted = 1; deleted <= testData.LongLength; deleted++)
{
// Act
list.RemoveAt(list.LongCount - 1);
// Validate
_ = list.Should().HaveCount(testData.Length - deleted)
.And.ContainInConsecutiveOrder(testData.Take(testData.Length - deleted))
.And.BeEquivalentTo(testData.Take(testData.Length - deleted));
}
_ = list.Should().BeEmpty();
_ = list.Capacity.Should().Be(32);
}
[Fact]
public void ConstructorSourceShouldInitializeList()
{
// Prepare
var testData = _testData.ToArray();
// Act
var list = new RecyclableBlockList<int>(testData);
// Validate
_ = list.Should().HaveCount(testData.Length)
.And.ContainInConsecutiveOrder(testData)
.And.BeEquivalentTo(testData);
}
[Fact]
public void EnumerateShouldYieldAllItemsInCorrectOrder()
{
// Prepare
var testData = _testData.ToArray();
var list = new RecyclableBlockList<int>(testData);
// Act
var yieldedItems = new List<int>();
foreach (var item in list)
{
yieldedItems.Add(item);
}
// Validate
_ = yieldedItems.Should().HaveCount(testData.Length)
.And.ContainInConsecutiveOrder(testData)
.And.BeEquivalentTo(testData);
}
}
}
@@ -3,7 +3,6 @@ using Recyclable.Collections;
namespace Recyclable.CollectionsTests namespace Recyclable.CollectionsTests
{ {
[TestClass()]
public class RecyclableListTests public class RecyclableListTests
{ {
private const int _totalObjectCount = 5_000; private const int _totalObjectCount = 5_000;
@@ -11,7 +10,7 @@ namespace Recyclable.CollectionsTests
private static readonly IEnumerable<int> _testData = Enumerable.Range(1, _totalObjectCount); private static readonly IEnumerable<int> _testData = Enumerable.Range(1, _totalObjectCount);
private static RecyclableList<int> CreateReversedRecyclableList(IEnumerable<int> source) => new(source); private static RecyclableList<int> CreateReversedRecyclableList(IEnumerable<int> source) => new(source);
[TestMethod] [Fact]
public void AddShouldAddItems() public void AddShouldAddItems()
{ {
// Prepare // Prepare
@@ -33,7 +32,7 @@ namespace Recyclable.CollectionsTests
} }
} }
[TestMethod] [Fact]
public void AddShouldAcceptDuplicates() public void AddShouldAcceptDuplicates()
{ {
// Prepare // Prepare
@@ -51,7 +50,7 @@ namespace Recyclable.CollectionsTests
_ = list.Should().BeEquivalentTo(testNumbers); _ = list.Should().BeEquivalentTo(testNumbers);
} }
[TestMethod] [Fact]
public void ConstructorShouldAcceptDuplicates() public void ConstructorShouldAcceptDuplicates()
{ {
// Prepare // Prepare
@@ -65,7 +64,7 @@ namespace Recyclable.CollectionsTests
_ = list.Should().BeEquivalentTo(testNumbers); _ = list.Should().BeEquivalentTo(testNumbers);
} }
[TestMethod] [Fact]
public void InitializeSortClearShouldSucceed() public void InitializeSortClearShouldSucceed()
{ {
var expectedList = _testData; var expectedList = _testData;
@@ -86,7 +85,7 @@ namespace Recyclable.CollectionsTests
_ = list.LongCount.Should().Be(0); _ = list.LongCount.Should().Be(0);
} }
[TestMethod] [Fact]
public void CopyToShouldCopyAllItems() public void CopyToShouldCopyAllItems()
{ {
// Prepare // Prepare
@@ -98,7 +97,7 @@ namespace Recyclable.CollectionsTests
_ = actual.Should().BeEquivalentTo(_testData); _ = actual.Should().BeEquivalentTo(_testData);
} }
[TestMethod] [Fact]
public void GetEnumeratorShouldYieldAllItems() public void GetEnumeratorShouldYieldAllItems()
{ {
// Prepare // Prepare
@@ -116,7 +115,7 @@ namespace Recyclable.CollectionsTests
_ = actual.Should().BeEquivalentTo(_testData); _ = actual.Should().BeEquivalentTo(_testData);
} }
[TestMethod] [Fact]
public void IndexOfShouldFindTheIndexes() public void IndexOfShouldFindTheIndexes()
{ {
// Prepare // Prepare
@@ -130,41 +129,37 @@ namespace Recyclable.CollectionsTests
} }
} }
[TestMethod] [Fact]
[ExpectedException(typeof(NotSupportedException))]
public void InsertShouldRaiseNotSupportedException() public void InsertShouldRaiseNotSupportedException()
{ {
// Prepare // Prepare
using var list = NewRecyclableList; using var list = NewRecyclableList;
// Act // Act
list.Insert(0, -1); _ = Assert.Throws<NotSupportedException>(() => list.Insert(0, -1));
} }
[TestMethod] [Fact]
[ExpectedException(typeof(NotSupportedException))]
public void RemoveShouldRaiseNotSupportedException() public void RemoveShouldRaiseNotSupportedException()
{ {
// Prepare // Prepare
using var list = NewRecyclableList; using var list = NewRecyclableList;
// Act // Act
bool removed = list.Remove(_testData.First()); _ = Assert.Throws<NotSupportedException>(() => list.Remove(_testData.First()));
_ = removed.Should().BeFalse();
} }
[TestMethod] [Fact]
[ExpectedException(typeof(NotSupportedException))]
public void RemoveAtShouldRaiseNotSupportedException() public void RemoveAtShouldRaiseNotSupportedException()
{ {
// Prepare // Prepare
using var list = NewRecyclableList; using var list = NewRecyclableList;
// Act // Act
list.RemoveAt(0); _ = Assert.Throws<NotSupportedException>(() => list.RemoveAt(0));
} }
[TestMethod] [Fact]
public void DisposeShouldSucceed() public void DisposeShouldSucceed()
{ {
// Prepare // Prepare
@@ -177,7 +172,7 @@ namespace Recyclable.CollectionsTests
_ = list.LongCount.Should().Be(0L); _ = list.LongCount.Should().Be(0L);
} }
[TestMethod] [Fact]
public void ConsecutiveDisposeShouldSucceed() public void ConsecutiveDisposeShouldSucceed()
{ {
// Prepare // Prepare
@@ -3,12 +3,11 @@ using Recyclable.Collections;
namespace Recyclable.CollectionsTests namespace Recyclable.CollectionsTests
{ {
[TestClass]
public class RecyclableQueueTests public class RecyclableQueueTests
{ {
private static readonly string[] _testData = new[] { "a", "d", "c", "b", "a" }; private static readonly string[] _testData = new[] { "a", "d", "c", "b", "a" };
[TestMethod] [Fact]
public void ShouldNotBeSortedWhenCreated() public void ShouldNotBeSortedWhenCreated()
{ {
// Act // Act
@@ -19,7 +18,7 @@ namespace Recyclable.CollectionsTests
.And.ContainInConsecutiveOrder(_testData); .And.ContainInConsecutiveOrder(_testData);
} }
[TestMethod] [Fact]
public void ShouldBeEmptyWhenNotInitialized() public void ShouldBeEmptyWhenNotInitialized()
{ {
// Act // Act
@@ -29,7 +28,7 @@ namespace Recyclable.CollectionsTests
_ = list.Should().BeEmpty(); _ = list.Should().BeEmpty();
} }
[TestMethod] [Fact]
public void ShouldNotBeSortedWhenInitialized() public void ShouldNotBeSortedWhenInitialized()
{ {
// Act // Act
@@ -48,7 +47,7 @@ namespace Recyclable.CollectionsTests
.And.BeEquivalentTo(_testData); .And.BeEquivalentTo(_testData);
} }
[TestMethod] [Fact]
public void ShouldBeEmptyAfterClear() public void ShouldBeEmptyAfterClear()
{ {
// Prepare // Prepare
@@ -61,7 +60,7 @@ namespace Recyclable.CollectionsTests
_ = list.Should().BeEmpty(); _ = list.Should().BeEmpty();
} }
[TestMethod] [Fact]
public void DequeueShouldReturnItemsInTheSameOrder() public void DequeueShouldReturnItemsInTheSameOrder()
{ {
// Prepare // Prepare
@@ -80,11 +79,11 @@ namespace Recyclable.CollectionsTests
} }
// Validate // Validate
_ = dequeuedItems.Should().ContainInConsecutiveOrder(_testData); _ = dequeuedItems.Should().ContainInConsecutiveOrder(_testData)
.And.BeEquivalentTo(_testData);
} }
[TestMethod] [Fact]
[ExpectedException(typeof(ArgumentOutOfRangeException))]
public void DequeueShoudRaiseArgumentOutOfRangeWhenNoMoreElementsFound() public void DequeueShoudRaiseArgumentOutOfRangeWhenNoMoreElementsFound()
{ {
// Prepare // Prepare
@@ -96,10 +95,11 @@ namespace Recyclable.CollectionsTests
_ = list.Dequeue(); _ = list.Dequeue();
} }
_ = list.Dequeue(); _ = Assert.Throws<ArgumentOutOfRangeException>(() => list.Dequeue());
_ = list.LongCount.Should().Be(0);
} }
[TestMethod] [Fact]
public void GetEnumeratorShouldYieldAllItemsInTheSameOrder() public void GetEnumeratorShouldYieldAllItemsInTheSameOrder()
{ {
// Prepare // Prepare
@@ -114,7 +114,8 @@ namespace Recyclable.CollectionsTests
} }
// Validate // Validate
_ = actual.Should().ContainInConsecutiveOrder(_testData); _ = actual.Should().ContainInConsecutiveOrder(_testData)
.And.BeEquivalentTo(_testData);
} }
} }
} }
@@ -3,12 +3,11 @@ using Recyclable.Collections;
namespace Recyclable.CollectionsTests namespace Recyclable.CollectionsTests
{ {
[TestClass()]
public class RecyclableSortedListTests public class RecyclableSortedListTests
{ {
private static readonly (int, string)[] _testData = new[] { (5, "a"), (4, "d"), (3, "c"), (2, "b"), (1, "a") }; private static readonly (int, string)[] _testData = new[] { (5, "a"), (4, "d"), (3, "c"), (2, "b"), (1, "a") };
[TestMethod] [Fact]
public void ShouldBeSortedWhenCreated() public void ShouldBeSortedWhenCreated()
{ {
// Act // Act
@@ -20,7 +19,7 @@ namespace Recyclable.CollectionsTests
.And.BeInAscendingOrder((item) => item.Key); .And.BeInAscendingOrder((item) => item.Key);
} }
[TestMethod] [Fact]
public void ShouldBeEmptyWhenNotInitialized() public void ShouldBeEmptyWhenNotInitialized()
{ {
// Act // Act
@@ -30,7 +29,7 @@ namespace Recyclable.CollectionsTests
_ = sortedList.Should().BeEmpty(); _ = sortedList.Should().BeEmpty();
} }
[TestMethod] [Fact]
public void ShouldNotBeSortedWhenInitialized() public void ShouldNotBeSortedWhenInitialized()
{ {
// Act // Act
@@ -48,7 +47,7 @@ namespace Recyclable.CollectionsTests
.And.ContainInConsecutiveOrder(_testData); .And.ContainInConsecutiveOrder(_testData);
} }
[TestMethod] [Fact]
public void ShouldBeSortedWhenUpdateEnds() public void ShouldBeSortedWhenUpdateEnds()
{ {
// Prepare // Prepare
@@ -71,7 +70,7 @@ namespace Recyclable.CollectionsTests
_ = sortedList.Should().BeInAscendingOrder(x => x.Key); _ = sortedList.Should().BeInAscendingOrder(x => x.Key);
} }
[TestMethod] [Fact]
public void ShouldBeEmptyAfterClear() public void ShouldBeEmptyAfterClear()
{ {
// Prepare // Prepare
@@ -3,12 +3,11 @@ using Recyclable.Collections;
namespace Recyclable.CollectionsTests namespace Recyclable.CollectionsTests
{ {
[TestClass]
public class RecyclableStackTests public class RecyclableStackTests
{ {
private static readonly string[] _testData = new[] { "a", "d", "c", "b", "a" }; private static readonly string[] _testData = new[] { "a", "d", "c", "b", "a" };
[TestMethod] [Fact]
public void GetEnumeratorShouldYieldAllItemsInReversedOrder() public void GetEnumeratorShouldYieldAllItemsInReversedOrder()
{ {
// Prepare // Prepare
@@ -26,7 +25,7 @@ namespace Recyclable.CollectionsTests
_ = actual.Should().ContainInConsecutiveOrder(_testData.Reverse()); _ = actual.Should().ContainInConsecutiveOrder(_testData.Reverse());
} }
[TestMethod] [Fact]
public void ShouldNotBeSortedWhenCreated() public void ShouldNotBeSortedWhenCreated()
{ {
// Act // Act
@@ -37,7 +36,7 @@ namespace Recyclable.CollectionsTests
.And.ContainInConsecutiveOrder(_testData); .And.ContainInConsecutiveOrder(_testData);
} }
[TestMethod] [Fact]
public void ShouldBeEmptyWhenNotInitialized() public void ShouldBeEmptyWhenNotInitialized()
{ {
// Act // Act
@@ -47,7 +46,7 @@ namespace Recyclable.CollectionsTests
_ = sortedList.Should().BeEmpty(); _ = sortedList.Should().BeEmpty();
} }
[TestMethod] [Fact]
public void ShouldNotBeSortedWhenInitialized() public void ShouldNotBeSortedWhenInitialized()
{ {
// Act // Act
@@ -66,7 +65,7 @@ namespace Recyclable.CollectionsTests
.And.BeEquivalentTo(_testData); .And.BeEquivalentTo(_testData);
} }
[TestMethod] [Fact]
public void ShouldBeEmptyAfterClear() public void ShouldBeEmptyAfterClear()
{ {
// Prepare // Prepare
@@ -79,7 +78,7 @@ namespace Recyclable.CollectionsTests
_ = sortedList.Should().BeEmpty(); _ = sortedList.Should().BeEmpty();
} }
[TestMethod] [Fact]
public void PopShouldReturnItemsInReversedOrder() public void PopShouldReturnItemsInReversedOrder()
{ {
// Prepare // Prepare
@@ -101,8 +100,7 @@ namespace Recyclable.CollectionsTests
_ = dequeuedItems.Should().ContainInConsecutiveOrder(_testData.Reverse()); _ = dequeuedItems.Should().ContainInConsecutiveOrder(_testData.Reverse());
} }
[TestMethod] [Fact]
[ExpectedException(typeof(ArgumentOutOfRangeException))]
public void PopShoudRaiseArgumentOutOfRangeWhenNoMoreElementsFound() public void PopShoudRaiseArgumentOutOfRangeWhenNoMoreElementsFound()
{ {
// Prepare // Prepare
@@ -114,7 +112,7 @@ namespace Recyclable.CollectionsTests
_ = list.Dequeue(); _ = list.Dequeue();
} }
_ = list.Dequeue(); _ = Assert.Throws<ArgumentOutOfRangeException>(() => list.Dequeue());
} }
} }
} }
+1 -1
View File
@@ -1 +1 @@
global using Microsoft.VisualStudio.TestTools.UnitTesting; global using Xunit;