improvements

Author: Petr Sramek

PolylineAlgorithm.slnx

@@ -10,4 +10,7 @@
   <Folder Name="/tests/">
     <Project Path="tests/PolylineAlgorithm.Tests/PolylineAlgorithm.Tests.csproj" />
   </Folder>
+  <Folder Name="/utilities/" Id="02ea681e-c7d8-13c7-8484-4ac65e1b71e8">
+    <Project Path="utilities/PolylineAlgorithm.Utility/PolylineAlgorithm.Utility.csproj" Id="69392841-91d5-4b8d-acdb-dd56c87b3034" />
+  </Folder>
 </Solution>

benchmarks/PolylineAlgorithm.Benchmarks/Internal/ValueProvider.cs

@@ -24,6 +24,7 @@
 
 	<ItemGroup>
 		<ProjectReference Include="..\..\src\PolylineAlgorithm\PolylineAlgorithm.csproj" />
+		<ProjectReference Include="..\..\utilities\PolylineAlgorithm.Utility\PolylineAlgorithm.Utility.csproj" />
 	</ItemGroup>
 
 </Project>

benchmarks/PolylineAlgorithm.Benchmarks/PolylineAlgorithm.Benchmarks.csproj

@@ -8,7 +8,7 @@ namespace PolylineAlgorithm.Benchmarks;
 using BenchmarkDotNet.Attributes;
 using BenchmarkDotNet.Engines;
 using PolylineAlgorithm;
-using PolylineAlgorithm.Benchmarks.Internal;
+using PolylineAlgorithm.Utility;
 
 /// <summary>
 /// Benchmarks for the <see cref="PolylineValue"/> struct.

benchmarks/PolylineAlgorithm.Benchmarks/PolylineBenchmark.cs

@@ -8,8 +8,8 @@ namespace PolylineAlgorithm.Benchmarks;
 using BenchmarkDotNet.Attributes;
 using BenchmarkDotNet.Engines;
 using PolylineAlgorithm;
-using PolylineAlgorithm.Benchmarks.Internal;
 using PolylineAlgorithm.Extensions;
+using PolylineAlgorithm.Utility;
 
 /// <summary>
 /// Benchmarks for the <see cref="PolylineDecoder"/> class.

benchmarks/PolylineAlgorithm.Benchmarks/PolylineDecoderBenchmark.cs

@@ -7,7 +7,7 @@ namespace PolylineAlgorithm.Benchmarks;
 
 using BenchmarkDotNet.Attributes;
 using PolylineAlgorithm;
-using PolylineAlgorithm.Benchmarks.Internal;
+using PolylineAlgorithm.Utility;
 using System.Collections.Generic;
 using System.Threading.Tasks;
 

benchmarks/PolylineAlgorithm.Benchmarks/PolylineEncoderBenchmark.cs

@@ -24,6 +24,7 @@
 
 	<ItemGroup>
 		<ProjectReference Include="..\..\src\PolylineAlgorithm\PolylineAlgorithm.csproj" />
+		<ProjectReference Include="..\..\utilities\PolylineAlgorithm.Utility\PolylineAlgorithm.Utility.csproj" />
 	</ItemGroup>
 
 </Project>

benchmarks/PolylineAlgorithm.Comparison.Benchmarks/Internal/ValueProvider.cs

@@ -9,8 +9,8 @@ namespace PolylineAlgorithm.Comparison.Benchmarks;
 using BenchmarkDotNet.Engines;
 using global::PolylineEncoder.Net.Utility;
 using PolylineAlgorithm;
-using PolylineAlgorithm.Comparison.Benchmarks.Internal;
 using PolylineAlgorithm.Extensions;
+using PolylineAlgorithm.Utility;
 using PolylinerNet;
 using PolylineEncoding = Cloudikka.PolylineAlgorithm.Encoding.PolylineEncoding;
 
@@ -21,8 +21,8 @@ namespace PolylineAlgorithm.Comparison.Benchmarks;
 public class PolylineDecoderBenchmark {
     private readonly Consumer _consumer = new();
 
-    [Params(1, 10, 100, 250, 500, 1_000, 2_500, 5_000, 7_500, 10_000, 15_000, 20_000, 25_000, 50_000, 75_000, 100_000, 250_000, 500_000, 750_000, 1_000_000)]
-    public int N;
+    [Params(1, 25, 50, 100, 250, 500, 1_000, 5_000, 10_000, 25_000, 50_000, 100_000, 500_000, 1_000_000)]
+    public int Count;
 
 #pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
     /// <summary>
@@ -53,8 +53,8 @@ public class PolylineDecoderBenchmark {
     /// </summary>
     [GlobalSetup]
     public void SetupData() {
-        StringValue = ValueProvider.GetPolyline(N).ToString();
-        PolylineValue = ValueProvider.GetPolyline(N);
+        StringValue = ValueProvider.GetPolyline(Count).ToString();
+        PolylineValue = ValueProvider.GetPolyline(Count);
     }
 
     /// <summary>

benchmarks/PolylineAlgorithm.Comparison.Benchmarks/PolylineAlgorithm.Comparison.Benchmarks.csproj

@@ -8,7 +8,7 @@ namespace PolylineAlgorithm.Comparison.Benchmarks;
 using BenchmarkDotNet.Attributes;
 using global::PolylineEncoder.Net.Utility;
 using PolylineAlgorithm;
-using PolylineAlgorithm.Comparison.Benchmarks.Internal;
+using PolylineAlgorithm.Utility;
 using PolylinerNet;
 using System.Collections.Generic;
 using System.Threading.Tasks;
@@ -19,21 +19,34 @@ namespace PolylineAlgorithm.Comparison.Benchmarks;
 /// </summary>
 [RankColumn]
 public class PolylineEncoderBenchmark {
-    [Params(1, 10, 100, 250, 500, 1_000, 2_500, 5_000, 7_500, 10_000, 15_000, 20_000, 25_000, 50_000, 75_000, 100_000, 250_000, 500_000, 750_000, 1_000_000)]
-    public int N;
+    [Params(1, 25, 50, 100, 250, 500, 1_000, 5_000, 10_000, 25_000, 50_000, 100_000, 500_000, 1_000_000)]
+    public int Count;
 
 #pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
     /// <summary>
     /// Gets the enumeration of coordinates to be encoded.
     /// </summary>
-    public static IEnumerable<Coordinate> Enumeration { get; private set; }
+    public static IEnumerable<Coordinate> PolylineAlgorithmEnumeration { get; private set; }
 
     /// <summary>
     /// Gets the list of coordinates to be encoded.
     /// </summary>
-    public static List<Coordinate> List { get; private set; }
+    public static List<Coordinate> PolylineAlgorithmList { get; private set; }
+
+    /// <summary>
+    /// Gets the enumeration of coordinates to be encoded.
+    /// </summary>
+    public static IEnumerable<(double, double)> CloudikkaEnumeration { get; private set; }
+
+    /// <summary>
+    /// Gets the list of coordinates to be encoded.
+    /// </summary>
+    public List<(double, double)> CloudikkaList { get; private set; }
+    public List<PolylinePoint> PolylinerList { get; private set; }
+    public List<Polylines.PolylineCoordinate> PolylinesList { get; private set; }
+    public List<Tuple<double, double>> PolylineUtilityList { get; private set; }
+
 
-    public static IAsyncEnumerable<Coordinate> AsyncEnumeration { get; private set; }
 #pragma warning restore CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
 
     /// <summary>
@@ -57,82 +70,73 @@ public class PolylineEncoderBenchmark {
     /// </summary>
     [GlobalSetup]
     public void SetupData() {
-        Enumeration = ValueProvider.GetCoordinates(N);
-        List = [.. Enumeration];
-        AsyncEnumeration = GetAsyncEnumeration(Enumeration!);
-    }
-
-    private async IAsyncEnumerable<Coordinate> GetAsyncEnumeration(IEnumerable<Coordinate> enumerable) {
-        foreach (var item in enumerable) {
-            yield return await new ValueTask<Coordinate>(item);
-        }
+        PolylineAlgorithmEnumeration = ValueProvider.GetCoordinates(Count);
+        PolylineAlgorithmList = [.. PolylineAlgorithmEnumeration];
+        CloudikkaEnumeration = PolylineAlgorithmEnumeration.Select(c => (c.Latitude, c.Longitude));
+        CloudikkaList = [.. CloudikkaEnumeration];
+        PolylinerList = PolylineAlgorithmEnumeration.Select(c => new PolylinePoint(c.Latitude, c.Longitude)).ToList();
+        PolylinesList = PolylineAlgorithmEnumeration.Select(c => new Polylines.PolylineCoordinate { Latitude = c.Latitude, Longitude = c.Longitude }).ToList();
+        PolylineUtilityList = PolylineAlgorithmEnumeration.Select(c => new Tuple<double, double>(c.Latitude, c.Longitude)).ToList();
     }
 
     /// <summary>
     /// Benchmarks the decoding of a polyline from a string.
     /// </summary>
+    [Benchmark]
+    public Polyline PolylineAlgorithm_Encode_Enumeration() {
+        return PolylineAlgorithm
+            .Encode(PolylineAlgorithmEnumeration);
+    }
+
     [Benchmark(Baseline = true)]
-    public Polyline PolylineAlgorithm_Encode() {
+    public Polyline PolylineAlgorithm_Encode_List() {
         return PolylineAlgorithm
-            .Encode(Enumeration);
+            .Encode(PolylineAlgorithmList);
     }
 
     /// <summary>
     /// Benchmarks the decoding of a polyline from a character array.
     /// </summary>
     [Benchmark]
-    public string Cloudikka_Encode() {
+    public string Cloudikka_Encode_Enumeration() {
         return Cloudikka
-            .Encode(Enumeration.Select(c => (c.Latitude, c.Longitude)));
+            .Encode(CloudikkaEnumeration);
     }
 
     /// <summary>
-    /// Benchmarks the decoding of a polyline from read-only memory.
+    /// Benchmarks the decoding of a polyline from a character array.
     /// </summary>
     [Benchmark]
-    public void PolylinerNet_Encode() {
-        PolylinerNet
-            .Encode([.. Enumeration.Select(c => new PolylinePoint(c.Latitude, c.Longitude))]);
+    public string Cloudikka_Encode_List() {
+        return Cloudikka
+            .Encode(CloudikkaList);
     }
 
     /// <summary>
     /// Benchmarks the decoding of a polyline from read-only memory.
     /// </summary>
     [Benchmark]
-    public string Polylines_Encode() {
-        return Polylines.Polyline
-            .EncodePoints(Enumeration.Select(c => new Polylines.PolylineCoordinate { Latitude = c.Latitude, Longitude = c.Longitude }));
+    public string PolylinerNet_Encode_List() {
+        return PolylinerNet
+            .Encode(PolylinerList);
     }
 
+
     /// <summary>
     /// Benchmarks the decoding of a polyline from read-only memory.
     /// </summary>
     [Benchmark]
-    public string PolylineUtility_Encode() {
-        return PolylineUtility
-            .Encode(Enumeration.Select(c => new Tuple<double, double>(c.Latitude, c.Longitude)));
+    public string Polylines_Encode_List() {
+        return Polylines.Polyline
+            .EncodePoints(PolylinesList);
     }
 
     /// <summary>
     /// Benchmarks the decoding of a polyline from read-only memory.
     /// </summary>
-    //[Benchmark]
-    //public void PolylineReader_ReadToEnd() {
-    //    PolylineReader reader = new(StringValue);
-
-    //    var result = ReadToEnd(ref reader);
-
-    //    result
-    //        .Consume(_consumer);
-
-    //    static IEnumerable<Coordinate> ReadToEnd(ref PolylineReader reader) {
-    //        var result = new List<Coordinate>();
-
-    //        while (reader.Read()) {
-    //            result.Add(new(reader.Latitude, reader.Longitude));
-    //        }
-
-    //        return result;
-    //    }
-    //}
+    [Benchmark]
+    public string PolylineUtility_Encode_List() {
+        return PolylineUtility
+            .Encode(PolylineUtilityList);
+    }
 }