Updated some API's and benchmarks

Author: linkdotnet

.DS_Store

@@ -23,4 +23,7 @@ robots.txt
 # Coverage files and reports
 /**/TestResults/*
 /**/coverage*.xml
-/CoverageReport/
+/CoverageReport/
+
+# MacOS
+.DS_Store

.gitignore

@@ -6,6 +6,9 @@ All notable changes to **ValueStringBuilder** will be documented in this file. T
 
 ## [Unreleased]
 
+### Added
+ - Smaller performance improvements in internal API's
+
 ## [1.4.1] - 2022-11-04
 
 ### Added

CHANGELOG.md

@@ -40,12 +40,21 @@ A more detailed documentation can be found [here](https://linkdotnet.github.io/S
 The following table gives you a small comparison between the `StringBuilder` which is part of .NET, [`ZString`](https://github.com/Cysharp/ZString) and the `ValueStringBuilder`:
 
 ```no-class
-|              Method |       Mean |    Error |    StdDev |     Median | Ratio | RatioSD |   Gen 0 |  Gen 1 | Allocated |
-|-------------------- |-----------:|---------:|----------:|-----------:|------:|--------:|--------:|-------:|----------:|
-| DotNetStringBuilder |   401.7 ns | 29.15 ns |  84.56 ns |   373.4 ns |  1.00 |    0.00 |  0.3576 |      - |   1,496 B |
-|  ValueStringBuilder |   252.8 ns |  9.05 ns |  26.27 ns |   249.0 ns |  0.65 |    0.13 |  0.1583 |      - |     664 B |
-|  ZStringBuilderUtf8 | 1,239.0 ns | 44.93 ns | 131.06 ns | 1,192.0 ns |  3.18 |    0.56 | 15.6250 |      - |  66,136 B |
-| ZStringBuilderUtf16 | 1,187.6 ns | 21.35 ns |  25.42 ns | 1,185.0 ns |  2.88 |    0.52 | 15.6250 | 0.0019 |  66,136 B |
+BenchmarkDotNet=v0.13.2, OS=macOS Monterey 12.6.1 (21G217) [Darwin 21.6.0]
+Apple M1 Pro, 1 CPU, 10 logical and 10 physical cores
+.NET SDK=7.0.100-rc.2.22477.23
+  [Host]     : .NET 6.0.10 (6.0.1022.47605), Arm64 RyuJIT AdvSIMD
+  DefaultJob : .NET 6.0.10 (6.0.1022.47605), Arm64 RyuJIT AdvSIMD
+
+
+|                         Method |       Mean |    Error |   StdDev | Ratio | RatioSD |    Gen0 | Allocated | Alloc Ratio |
+|------------------------------- |-----------:|---------:|---------:|------:|--------:|--------:|----------:|------------:|
+|            DotNetStringBuilder |   227.3 ns |  1.31 ns |  1.22 ns |  1.00 |    0.00 |  0.7114 |    1488 B |        1.00 |
+|             ValueStringBuilder |   128.7 ns |  0.57 ns |  0.53 ns |  0.57 |    0.00 |  0.2677 |     560 B |        0.38 |
+| ValueStringBuilderPreAllocated |   113.9 ns |  0.67 ns |  0.60 ns |  0.50 |    0.00 |  0.2677 |     560 B |        0.38 |
+|             ZStringBuilderUtf8 | 1,976.1 ns | 17.33 ns | 15.37 ns |  8.69 |    0.08 | 31.2500 |   66120 B |       44.44 |
+|            ZStringBuilderUtf16 | 1,888.2 ns | 18.50 ns | 16.40 ns |  8.30 |    0.09 | 31.2500 |   66120 B |       44.44 |
+
 ```
 
 For more comparison check the documentation.

README.md

@@ -1,4 +1,3 @@
-using System.Buffers;
 using System.Runtime.CompilerServices;
 
 namespace LinkDotNet.StringBuilder;
@@ -19,7 +18,7 @@ internal ref struct TypedSpanList<T>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public TypedSpanList()
     {
-        buffer = new T[8];
+        buffer = GC.AllocateUninitializedArray<T>(8);
         count = 0;
     }
 
@@ -43,9 +42,8 @@ private void Grow(int capacity = 0)
     {
         var currentSize = buffer.Length;
         var newSize = capacity > 0 ? capacity : currentSize * 2;
-        var rented = ArrayPool<T>.Shared.Rent(newSize);
+        var rented = GC.AllocateUninitializedArray<T>(newSize);
         buffer.CopyTo(rented);
         buffer = rented;
-        ArrayPool<T>.Shared.Return(rented);
     }
 }

src/LinkDotNet.StringBuilder/TypedSpanList.cs

@@ -244,12 +244,12 @@ public int LastIndexOf(ReadOnlySpan<char> word, int startIndex)
     /// <summary>
     /// Disposes the instance and returns rented buffer from an array pool if needed.
     /// </summary>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void Dispose()
     {
-        var toReturn = arrayFromPool;
-        if (toReturn != null)
+        if (arrayFromPool != null)
         {
-            ArrayPool<char>.Shared.Return(toReturn);
+            ArrayPool<char>.Shared.Return(arrayFromPool);
         }
     }
 

src/LinkDotNet.StringBuilder/ValueStringBuilder.cs

@@ -29,6 +29,18 @@ public string ValueStringBuilder()
         return builder.ToString();
     }
 
+    [Benchmark]
+    public string ValueStringBuilderPreAllocated()
+    {
+        using var builder = new ValueStringBuilder(stackalloc char[256]);
+        builder.AppendLine("That is the first line of our benchmark.");
+        builder.AppendLine("We can multiple stuff in here if want.");
+        builder.AppendLine("We can multiple stuff in here if want.");
+        builder.AppendLine("The idea is that we can resize the internal structure from time to time.");
+        builder.AppendLine("We can also add other Append method if we want. But we keep it easy for now.");
+        return builder.ToString();
+    }
+
     [Benchmark]
     public string ZStringBuilderUtf8()
     {

tests/LinkDotNet.StringBuilder.Benchmarks/AppendBenchmark.cs

@@ -6,12 +6,14 @@ namespace LinkDotNet.StringBuilder.Benchmarks;
 [MemoryDiagnoser]
 public class AppendValueTypes
 {
+    private const int NumberOfIterations = 25;
+
     [Benchmark]
     public string DotNetStringBuilder()
     {
         var builder = new System.Text.StringBuilder();
 
-        for (var i = 0; i < 25; i++)
+        for (var i = 0; i < NumberOfIterations; i++)
         {
             builder.Append(true);
             builder.Append(int.MaxValue);
@@ -29,7 +31,7 @@ public string ValueStringBuilder()
     {
         using var builder = new ValueStringBuilder();
 
-        for (var i = 0; i < 25; i++)
+        for (var i = 0; i < NumberOfIterations; i++)
         {
             builder.Append(true);
             builder.Append(int.MaxValue);
@@ -47,7 +49,7 @@ public string ZStringBuilder()
     {
         var builder = ZString.CreateStringBuilder();
 
-        for (var i = 0; i < 25; i++)
+        for (var i = 0; i < NumberOfIterations; i++)
         {
             builder.Append(true);
             builder.Append(int.MaxValue);