Remove ZString from docs

linkdotnet · Jul 13, 2023 · 1c31b33 · 1c31b33
1 parent 66a154f
commit 1c31b33
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 54 deletions.
diff --git a/docs/site/articles/comparison.md b/docs/site/articles/comparison.md
@@ -4,7 +4,7 @@ uid: comparison
 
 # Comparison
 
-The following document will show some key differences between the `ValueStringBuilder` and similar working string builder like the one from .NET itself or the famous `ZString` package, which is also free and open-source.
+The following document will show some key differences between the `ValueStringBuilder` and similar working string builder like the one from .NET itself.
 
 ## System.Text.StringBuilder
 
@@ -17,28 +17,15 @@ The `StringBuilder` shipped with the .NET Framework itself is a all-purpose stri
  - `StringBuilder` has a richer API as the `ValueStringBuilder`. In the future they should have the same amount of API's as the `StringBuilder` is the "big brother" of this package.
  - `ValueStringBuilder` has different API calls like [`IndexOf`](xref:LinkDotNet.StringBuilder.ValueStringBuilder.IndexOf(ReadOnlySpan{System.Char})) or [`LastIndexOf`](xref:LinkDotNet.StringBuilder.ValueStringBuilder.LastIndexOf(ReadOnlySpan{System.Char})).
 
-## `ZString`
-Both string builder use similiar concepts to achieve. Both,`ValueStringBuilder` and `ZString`, are declared as `struct`s. `ValueStringBuilder` goes one step further and enforces its lifecycle to live on the **stack** and can never be put on the **heap**.
-
-**Key differences**:
- - `ValueStringBuilder` is a `ref struct` which can never placed on the heap. `ZString` can be defined as a `class` field.
- - `ZString` has a very big initial buffer in its default (64kb) which can lead to more pressure on the GC.
- - `ZString` is more general purpose than `ValueStringBuilder` is.
- - `ZString` offers a richer API than the `ValueStringBuilder`. In the future that should change.
- - `ValueStringBuilder` has different API calls like [`IndexOf`](xref:LinkDotNet.StringBuilder.ValueStringBuilder.IndexOf(ReadOnlySpan{System.Char})) or [`LastIndexOf`](xref:LinkDotNet.StringBuilder.ValueStringBuilder.LastIndexOf(ReadOnlySpan{System.Char})).
-
-
 ## Benchmark
 
-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`:
+The following table gives you a small comparison between the `StringBuilder` which is part of .NET and the `ValueStringBuilder`:
 
 ```
 |              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 |
 ```
 
 For more comparison check the documentation.
@@ -51,7 +38,6 @@ Another benchmark shows that this `ValueStringBuilder` uses less memory when it
 |-------------------- |---------:|---------:|---------:|--------:|-------:|----------:|
 | DotNetStringBuilder | 16.31 us | 0.414 us | 1.208 us |  1.5259 |      - |      6 KB |
 |  ValueStringBuilder | 14.61 us | 0.292 us | 0.480 us |  0.3357 |      - |      1 KB |
-|      ZStringBuilder | 15.47 us | 0.249 us | 0.323 us | 16.1285 | 0.0153 |     67 KB |
 
 ```
 

diff --git a/tests/LinkDotNet.StringBuilder.Benchmarks/AppendBenchmark.cs b/tests/LinkDotNet.StringBuilder.Benchmarks/AppendBenchmark.cs
@@ -1,5 +1,4 @@
 using BenchmarkDotNet.Attributes;
-using Cysharp.Text;
 
 namespace LinkDotNet.StringBuilder.Benchmarks;
 

diff --git a/tests/LinkDotNet.StringBuilder.Benchmarks/AppendValueTypesBenchmark.cs b/tests/LinkDotNet.StringBuilder.Benchmarks/AppendValueTypesBenchmark.cs
@@ -1,5 +1,4 @@
 using BenchmarkDotNet.Attributes;
-using Cysharp.Text;
 
 namespace LinkDotNet.StringBuilder.Benchmarks;
 
@@ -25,40 +24,4 @@ public string DotNetStringBuilder()
 
         return builder.ToString();
     }
-
-    [Benchmark]
-    public string ValueStringBuilder()
-    {
-        using var builder = new ValueStringBuilder();
-
-        for (var i = 0; i < NumberOfIterations; i++)
-        {
-            builder.Append(true);
-            builder.Append(int.MaxValue);
-            builder.Append(decimal.MaxValue);
-            builder.Append(byte.MinValue);
-            builder.Append(float.Epsilon);
-            builder.Append(double.Epsilon);
-        }
-
-        return builder.ToString();
-    }
-
-    [Benchmark]
-    public string ZStringBuilder()
-    {
-        var builder = ZString.CreateStringBuilder();
-
-        for (var i = 0; i < NumberOfIterations; i++)
-        {
-            builder.Append(true);
-            builder.Append(int.MaxValue);
-            builder.Append(decimal.MaxValue);
-            builder.Append(byte.MinValue);
-            builder.Append(float.Epsilon);
-            builder.Append(double.Epsilon);
-        }
-
-        return builder.ToString();
-    }
 }