Added immutable benchmark

Author: linkdotnet

ImmutablePerformance/AddBenchmark.cs

@@ -0,0 +1,29 @@
+using System.Collections.Immutable;
+using System.Collections.ObjectModel;
+using BenchmarkDotNet.Attributes;
+
+[MemoryDiagnoser]
+public class AddBenchmark
+{
+    private readonly ReadOnlyCollection<int> _readOnlyNumbers = Enumerable.Range(0, 1_000).ToList().AsReadOnly();
+    private readonly ImmutableArray<int> _immutableArray = Enumerable.Range(0, 1_000).ToImmutableArray();
+    private readonly ImmutableList<int> _immutableList = Enumerable.Range(0, 1_000).ToImmutableList();
+
+    private readonly int[] numbersToAdd = { 1, 2, 3, 4, 5, 6, 7, 8 };
+
+    [Benchmark]
+    public IReadOnlyList<int> AddElementReadOnlyCollection()
+    {
+        var l = _readOnlyNumbers.ToList();
+        l.AddRange(numbersToAdd);
+        return l;
+    }
+
+    [Benchmark]
+    public ImmutableArray<int> AddElementImmutableArray()
+        => _immutableArray.AddRange(numbersToAdd);
+
+    [Benchmark]
+    public ImmutableList<int> AddElementImmutableList()
+        => _immutableList.AddRange(numbersToAdd);
+}

ImmutablePerformance/ImmutablePerformance.csproj

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net7.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <PackageReference Include="BenchmarkDotNet" Version="0.13.5" />
+    </ItemGroup>
+
+</Project>

ImmutablePerformance/ImmutablePerformance.sln

@@ -0,0 +1,16 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ImmutablePerformance", "ImmutablePerformance.csproj", "{CCA4AEAC-2B9E-43A4-8D94-4633B7F6B0E5}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{CCA4AEAC-2B9E-43A4-8D94-4633B7F6B0E5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{CCA4AEAC-2B9E-43A4-8D94-4633B7F6B0E5}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{CCA4AEAC-2B9E-43A4-8D94-4633B7F6B0E5}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{CCA4AEAC-2B9E-43A4-8D94-4633B7F6B0E5}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+EndGlobal

ImmutablePerformance/IterateBenchmark.cs

@@ -0,0 +1,59 @@
+using System.Collections.Immutable;
+using System.Collections.ObjectModel;
+using BenchmarkDotNet.Attributes;
+
+public class IterateBenchmark
+{
+    private readonly List<int> _numbers = Enumerable.Range(0, 1_000).ToList();
+    private readonly ReadOnlyCollection<int> _readOnlyNumbers = Enumerable.Range(0, 1_000).ToList().AsReadOnly();
+    private readonly ImmutableArray<int> _immutableArray = Enumerable.Range(0, 1_000).ToImmutableArray();
+    private readonly ImmutableList<int> _immutableList = Enumerable.Range(0, 1_000).ToImmutableList();
+
+    [Benchmark(Baseline = true)]
+    public int IterateList()
+    {
+        var sum = 0;
+        for (var i = 0; i < _numbers.Count; i++)
+        {
+            sum += _numbers[i];
+        }
+
+        return sum;
+    }
+
+    [Benchmark]
+    public int IterateReadOnlyCollection()
+    {
+        var sum = 0;
+        for (var i = 0; i < _readOnlyNumbers.Count; i++)
+        {
+            sum += _readOnlyNumbers[i];
+        }
+
+        return sum;
+    }
+
+    [Benchmark]
+    public int IterateImmutableArray()
+    {
+        var sum = 0;
+        for (var i = 0; i < _immutableArray.Length; i++)
+        {
+            sum += _immutableArray[i];
+        }
+
+        return sum;
+    }
+
+    [Benchmark]
+    public int IterateImmutableList()
+    {
+        var sum = 0;
+        for (var i = 0; i < _immutableList.Count; i++)
+        {
+            sum += _immutableList[i];
+        }
+
+        return sum;
+    }
+}

ImmutablePerformance/Program.cs

@@ -0,0 +1,3 @@
+using BenchmarkDotNet.Running;
+
+BenchmarkSwitcher.FromAssembly(typeof(Program).Assembly).Run();

ImmutablePerformance/README.md

@@ -0,0 +1,7 @@
+# Performance (ReadOnly)List vs Immutable collection types
+
+A bit back on LinkedIn, there was a discussion about read-only collection and immutability where this is not the point I want to discuss now, as I already covered that here: [*"ReadOnlyCollection is not an immutable collection"*](https://steven-giesel.com/blogPost/c20eb758-a611-4f98-9ddf-b9e2b83fcac9).
+
+This post is just about the performance of those types compared to our baseline, the good old `List<T>`. It also explains why we see the results we see.
+
+Found [here](https://steven-giesel.com/blogPost/3bd2cb74-58a4-42cd-90e3-6c3a8befe854)

README.md

@@ -4,6 +4,7 @@ Contains all of my examples from various blog posts. You can find a comprehensiv
 
 | BlogPost                                                                                 | Publish Date |
 | ---------------------------------------------------------------------------------------- | ------------ |
+| [Performance (ReadOnly)List vs Immutable collection types](ImmutablePerformance/)        | 26.02.2023   |
 | [Multi-Tenancy with RavenDB and ASP.NET Core](MultiTenantRavenDB/)                       | 05.02.2023   |
 | [Easy Pagintion for Entity Framework in 3 steps](PaginationEF/)                          | 09.01.2023   |
 | [Give your strings context with StringSyntaxAttribute](StringHightlighting/)             | 01.01.2023   |