diff --git a/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/Program.cs b/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/Program.cs index 78ac21b592..d9d3b3b03f 100644 --- a/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/Program.cs +++ b/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/Program.cs @@ -1,4 +1,21 @@ using BenchmarkDotNet.Running; using RandomizeGenericListsInCSharp; -var summary = BenchmarkRunner.Run(); \ No newline at end of file +if (args.Length > 0) +{ + BenchmarkSwitcher.FromAssembly(typeof(RandomizeGenericListsBenchmarks).Assembly).Run(args); + return; +} + +var methods = new RandomizeGenericListsMethods(); +string[] orders = ["123", "132", "213", "231", "312", "321"]; + +PrintCounts("Fisher-Yates", methods.CountOrders(methods.GenerateRandomLoop, 60_000)); +PrintCounts("Random.Shuffle", methods.CountOrders(methods.GenerateRandomShuffle, 60_000)); +PrintCounts("Biased loop", methods.CountOrders(methods.GenerateBiasedLoop, 60_000)); + +void PrintCounts(string name, Dictionary counts) +{ + var line = string.Join(" ", orders.Select(o => $"{o}: {counts.GetValueOrDefault(o),6}")); + Console.WriteLine($"{name,-15}{line}"); +} diff --git a/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/RandomizeGenericListsBenchmarks.cs b/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/RandomizeGenericListsBenchmarks.cs new file mode 100644 index 0000000000..4e4f7bdf01 --- /dev/null +++ b/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/RandomizeGenericListsBenchmarks.cs @@ -0,0 +1,43 @@ +using BenchmarkDotNet.Attributes; +using BenchmarkDotNet.Order; + +namespace RandomizeGenericListsInCSharp; + +[InProcess] +[MemoryDiagnoser] +[Orderer(SummaryOrderPolicy.FastestToSlowest)] +[RankColumn] +public class RandomizeGenericListsBenchmarks +{ + private readonly RandomizeGenericListsMethods _methods = new(); + private List _orderedList = []; + private List _listToShuffle = []; + + [GlobalSetup] + public void GlobalSetup() + { + _orderedList = _methods.OrderedInts(1_000_000); + } + + // The in-place shuffles change the list they get, so each iteration starts from a fresh ordered copy. + [IterationSetup(Targets = [nameof(GenerateRandomLoop), nameof(GenerateRandomShuffle)])] + public void ResetList() + { + _listToShuffle = new List(_orderedList); + } + + [Benchmark] + public List GenerateRandomLoop() => _methods.GenerateRandomLoop(_listToShuffle); + + [Benchmark] + public List GenerateRandomShuffle() => _methods.GenerateRandomShuffle(_listToShuffle); + + [Benchmark] + public List GenerateLinqShuffle() => _methods.GenerateLinqShuffle(_orderedList); + + [Benchmark] + public List GenerateRandomOrderBy() => _methods.GenerateRandomOrderBy(_orderedList); + + [Benchmark] + public List GenerateRandomOrderByGuid() => _methods.GenerateRandomOrderByGuid(_orderedList); +} diff --git a/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp.csproj b/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp.csproj index 9f07173211..1a81128a7d 100644 --- a/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp.csproj +++ b/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp.csproj @@ -2,13 +2,13 @@ Exe - net7.0 + net11.0 enable enable - + diff --git a/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/RandomizeGenericListsMethods.cs b/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/RandomizeGenericListsMethods.cs index 0f970c62d1..10399a705b 100644 --- a/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/RandomizeGenericListsMethods.cs +++ b/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsInCSharp/RandomizeGenericListsMethods.cs @@ -1,66 +1,93 @@ -using BenchmarkDotNet.Attributes; +using System.Runtime.InteropServices; -namespace RandomizeGenericListsInCSharp +namespace RandomizeGenericListsInCSharp; + +public class RandomizeGenericListsMethods { - [MemoryDiagnoser] - [Orderer(BenchmarkDotNet.Order.SummaryOrderPolicy.FastestToSlowest)] - [RankColumn] - public class RandomizeGenericListsMethods + private readonly Random _rand; + + public RandomizeGenericListsMethods() { - private readonly Random _rand; + _rand = new Random(); + } - public RandomizeGenericListsMethods() - { - _rand = new Random(); - } - public IEnumerable> SampleList() + public List GenerateRandomLoop(List listToShuffle) + { + for (int i = listToShuffle.Count - 1; i > 0; i--) { - yield return OrderedInts(1000000); + var k = _rand.Next(i + 1); + var value = listToShuffle[k]; + listToShuffle[k] = listToShuffle[i]; + listToShuffle[i] = value; } - [ArgumentsSource(nameof(SampleList))] - [Benchmark] - public List GenerateRandomLoop(List listToShuffle) + return listToShuffle; + } + + public List GenerateRandomShuffle(List listToShuffle) + { + _rand.Shuffle(CollectionsMarshal.AsSpan(listToShuffle)); + + return listToShuffle; + } + + public List GenerateLinqShuffle(List listToShuffle) + { + var shuffledList = listToShuffle.Shuffle().ToList(); + + return shuffledList; + } + + public List GenerateRandomOrderBy(List listToShuffle) + { + var shuffledList = listToShuffle.OrderBy(_ => _rand.Next()).ToList(); + + return shuffledList; + } + + public List GenerateRandomOrderByGuid(List listToShuffle) + { + var shuffledList = listToShuffle.OrderBy(_ => Guid.NewGuid()).ToList(); + + return shuffledList; + } + + // Don't do this: it picks k from the entire list, so some orders come up more often than others. + public List GenerateBiasedLoop(List listToShuffle) + { + for (int i = listToShuffle.Count - 1; i >= 0; i--) { - for (int i = listToShuffle.Count - 1; i > 0; i--) - { - var k = _rand.Next(i + 1); - var value = listToShuffle[k]; - listToShuffle[k] = listToShuffle[i]; - listToShuffle[i] = value; - } - - return listToShuffle; + var k = _rand.Next(listToShuffle.Count); + var value = listToShuffle[k]; + listToShuffle[k] = listToShuffle[i]; + listToShuffle[i] = value; } - [ArgumentsSource(nameof(SampleList))] - [Benchmark] - public List GenerateRandomOrderBy(List listToShuffle) - { - var shuffledList = listToShuffle.OrderBy(_ => _rand.Next()).ToList(); + return listToShuffle; + } - return shuffledList; - } + public Dictionary CountOrders(Func, List> shuffle, int runs) + { + var counts = new Dictionary(); - [ArgumentsSource(nameof(SampleList))] - [Benchmark] - public List GenerateRandomOrderByGuid(List listToShuffle) + for (int run = 0; run < runs; run++) { - var shuffledList = listToShuffle.OrderBy(_ => Guid.NewGuid()).ToList(); - - return shuffledList; + var order = string.Concat(shuffle([1, 2, 3])); + counts[order] = counts.GetValueOrDefault(order) + 1; } - public List OrderedInts(int size) - { - var numbers = new List(); + return counts; + } - for (int i = 0; i < size; i++) - { - numbers.Add(i); - } + public List OrderedInts(int size) + { + var numbers = new List(); - return numbers; + for (int i = 0; i < size; i++) + { + numbers.Add(i); } + + return numbers; } -} \ No newline at end of file +} diff --git a/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsTests/RandomizeGenericListsTests.csproj b/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsTests/RandomizeGenericListsTests.csproj index 43b785f35b..93589bda85 100644 --- a/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsTests/RandomizeGenericListsTests.csproj +++ b/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsTests/RandomizeGenericListsTests.csproj @@ -1,7 +1,7 @@  - net7.0 + net11.0 enable enable @@ -9,10 +9,10 @@ - - - - + + + + diff --git a/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsTests/RandomizeGenericListsUnitTests.cs b/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsTests/RandomizeGenericListsUnitTests.cs index d6ab987836..a9320cb4c1 100644 --- a/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsTests/RandomizeGenericListsUnitTests.cs +++ b/collections-lists/RandomizeGenericListsInCSharp/RandomizeGenericListsTests/RandomizeGenericListsUnitTests.cs @@ -15,27 +15,37 @@ public RandomizeGenericListsUnitTests() } [TestMethod] - public void GivenAnOrderedList_WhenNotEmpty_VerifyShuffleGuid() + public void GivenAnOrderedList_WhenNotEmpty_VerifyShuffleLoop() { - var shuffledList = _randomizeListObj.GenerateRandomOrderByGuid(_orderedList); + var listToShuffle = new List(_orderedList); - var firstVal = shuffledList.First(); - var lastVal = shuffledList.Last(); - - Assert.AreNotEqual(firstVal, 0); - Assert.AreNotEqual(lastVal, 999999); + var shuffledList = _randomizeListObj.GenerateRandomLoop(listToShuffle); + + Assert.AreSame(listToShuffle, shuffledList); + CollectionAssert.AreEquivalent(_orderedList, shuffledList); + CollectionAssert.AreNotEqual(_orderedList, shuffledList); } [TestMethod] - public void GivenAnOrderedList_WhenNotEmpty_VerifyShuffleLoop() + public void GivenAnOrderedList_WhenNotEmpty_VerifyRandomShuffle() { - var shuffledList = _randomizeListObj.GenerateRandomLoop(_orderedList); + var listToShuffle = new List(_orderedList); - var firstVal = shuffledList.First(); - var lastVal = shuffledList.Last(); + var shuffledList = _randomizeListObj.GenerateRandomShuffle(listToShuffle); - Assert.AreNotEqual(firstVal, 0); - Assert.AreNotEqual(lastVal, 999999); + Assert.AreSame(listToShuffle, shuffledList); + CollectionAssert.AreEquivalent(_orderedList, shuffledList); + CollectionAssert.AreNotEqual(_orderedList, shuffledList); + } + + [TestMethod] + public void GivenAnOrderedList_WhenNotEmpty_VerifyLinqShuffle() + { + var shuffledList = _randomizeListObj.GenerateLinqShuffle(_orderedList); + + Assert.AreNotSame(_orderedList, shuffledList); + CollectionAssert.AreEquivalent(_orderedList, shuffledList); + CollectionAssert.AreNotEqual(_orderedList, shuffledList); } [TestMethod] @@ -43,21 +53,35 @@ public void GivenAnOrderedList_WhenNotEmpty_VerifyRandomOrderby() { var shuffledList = _randomizeListObj.GenerateRandomOrderBy(_orderedList); - var firstVal = shuffledList.First(); - var lastVal = shuffledList.Last(); + Assert.AreNotSame(_orderedList, shuffledList); + CollectionAssert.AreEquivalent(_orderedList, shuffledList); + CollectionAssert.AreNotEqual(_orderedList, shuffledList); + } + + [TestMethod] + public void GivenAnOrderedList_WhenNotEmpty_VerifyShuffleGuid() + { + var shuffledList = _randomizeListObj.GenerateRandomOrderByGuid(_orderedList); - Assert.AreNotEqual(firstVal, 0); - Assert.AreNotEqual(lastVal, 999999); + Assert.AreNotSame(_orderedList, shuffledList); + CollectionAssert.AreEquivalent(_orderedList, shuffledList); + CollectionAssert.AreNotEqual(_orderedList, shuffledList); } [TestMethod] - public void GivenAnInteger_WhenListIsEmpty_VerifyOrderedListGenerated() + public void GivenAThreeElementList_WhenShuffledManyTimes_VerifyFisherYatesProducesEveryOrder() { - var firstVal = _orderedList.First(); - var lastVal = _orderedList.Last(); + var counts = _randomizeListObj.CountOrders(_randomizeListObj.GenerateRandomLoop, 60_000); - Assert.AreEqual(firstVal, 0); - Assert.AreEqual(lastVal, 999999); - Assert.IsInstanceOfType(_orderedList, typeof(List)); + Assert.HasCount(6, counts); + Assert.AreEqual(60_000, counts.Values.Sum()); + } + + [TestMethod] + public void GivenAnInteger_WhenListIsEmpty_VerifyOrderedListGenerated() + { + Assert.AreEqual(0, _orderedList.First()); + Assert.AreEqual(999999, _orderedList.Last()); + Assert.HasCount(1000000, _orderedList); } -} \ No newline at end of file +}