Update benchmarks

Author: JimBobSquarePants

tests/PolygonClipper.Benchmarks/Benches.cs

@@ -0,0 +1,37 @@
+// Copyright (c) Six Labors.
+// Licensed under the Six Labors Split License.
+
+#nullable disable
+
+using BenchmarkDotNet.Attributes;
+using GeoJSON.Text.Feature;
+using PolygonClipper.Tests;
+using PolygonClipper.Tests.TestCases;
+
+namespace PolygonClipper.Benchmarks;
+
+/// <summary>
+/// Benchmarks the performance of <c>PolygonClipper</c> for polygon union operations using a fixed input dataset.
+/// </summary>
+[MemoryDiagnoser]
+[OperationsPerSecond]
+public class Benches
+{
+    private Polygon subject;
+    private Polygon clipping;
+
+    [Params("hole_hole.geojson", "states_source.geojson", "asia.geojson")]
+    public string File { get; set; }
+
+    [GlobalSetup]
+    public void Setup()
+    {
+        FeatureCollection collection = TestData.Benchmarks.GetFeatureCollection(this.File);
+        (Polygon subject, Polygon clipping) = TestPolygonUtilities.BuildPolygon(collection);
+        this.subject = subject;
+        this.clipping = clipping;
+    }
+
+    [Benchmark]
+    public Polygon PolygonClipper() => global::PolygonClipper.PolygonClipper.Union(this.subject, this.clipping);
+}

tests/PolygonClipper.Benchmarks/ClippingLibraryComparison.cs

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
@@ -36,7 +36,6 @@
 
   <ItemGroup>
     <PackageReference Include="BenchmarkDotNet" Version="0.14.0" />
-    <PackageReference Include="Clipper2" Version="1.5.4" />
   </ItemGroup>
 
   <ItemGroup>

tests/PolygonClipper.Benchmarks/PolygonClipper.Benchmarks.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <CodeAnalysisRuleSet>..\sixlabors.tests.ruleset</CodeAnalysisRuleSet>
@@ -23,7 +23,6 @@
     <PackageReference Include="xunit" Version="2.4.0" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" />
     <PackageReference Include="coverlet.collector" Version="1.2.0" />
-    <PackageReference Include="Clipper2" Version="1.5.4" />
   </ItemGroup>
 
   <ItemGroup>

tests/PolygonClipper.Tests/PolygonClipper.Tests.csproj

@@ -40,6 +40,27 @@ private static string GetGeoJsonPath(string fileName)
             => GetFullPath(nameof(Generic), fileName);
     }
 
+    public static class Benchmarks
+    {
+        public static IEnumerable<string> GetFileNames()
+        {
+            DirectoryInfo info = new(Path.Combine(TestEnvironment.GeoJsonTestDataFullPath, nameof(Benchmarks)));
+            foreach (FileInfo file in info.EnumerateFiles("*.geojson"))
+            {
+                yield return file.Name;
+            }
+        }
+
+        public static FeatureCollection GetFeatureCollection(string fileName)
+        {
+            string path = GetGeoJsonPath(fileName);
+            return JsonSerializer.Deserialize<FeatureCollection>(File.ReadAllText(path))!;
+        }
+
+        private static string GetGeoJsonPath(string fileName)
+            => GetFullPath(nameof(Benchmarks), fileName);
+    }
+
     private static string GetFullPath(string folder, string fileName)
         => Path.Combine(TestEnvironment.GeoJsonTestDataFullPath, folder, fileName);
 }

tests/PolygonClipper.Tests/TestData.cs

@@ -2,7 +2,6 @@
 // Licensed under the Six Labors Split License.
 
 using System;
-using Clipper2Lib;
 using GeoJSON.Text.Feature;
 using GeoJSON.Text.Geometry;
 
@@ -23,17 +22,6 @@ public static (Polygon Subject, Polygon Clipping) BuildPolygon(FeatureCollection
         return (subject, clipping);
     }
 
-    public static (PathsD Subject, PathsD Clipping) BuildClipper2Polygon(FeatureCollection data)
-    {
-        IGeometryObject subjectGeometry = data.Features[0].Geometry;
-        IGeometryObject clippingGeometry = data.Features[1].Geometry;
-
-        PathsD subject = ConvertToClipper2Polygon(subjectGeometry);
-        PathsD clipping = ConvertToClipper2Polygon(clippingGeometry);
-
-        return (subject, clipping);
-    }
-
     private static Polygon ConvertToPolygon(IGeometryObject geometry)
     {
         if (geometry is GeoPolygon geoJsonPolygon)
@@ -86,69 +74,4 @@ private static Polygon ConvertToPolygon(IGeometryObject geometry)
 
         throw new InvalidOperationException("Unsupported geometry type.");
     }
-
-    private static PathsD ConvertToClipper2Polygon(IGeometryObject geometry)
-    {
-        if (geometry is GeoPolygon geoJsonPolygon)
-        {
-            // Convert GeoJSON Polygon to our Polygon type
-            PathsD polygon = [];
-            foreach (LineString ring in geoJsonPolygon.Coordinates)
-            {
-                PathD contour = [];
-                foreach (IPosition xy in ring.Coordinates)
-                {
-                    contour.Add(new PointD(xy.Longitude, xy.Latitude));
-                }
-
-                if (!ring.IsClosed())
-                {
-                    contour.Add(contour[0]);
-                }
-
-                polygon.Add(contour);
-            }
-
-            return polygon;
-        }
-        else if (geometry is MultiPolygon geoJsonMultiPolygon)
-        {
-            // Convert GeoJSON MultiPolygon to our Polygon type
-            PathsD polygon = [];
-
-            // Clipper2 expects holes run in the opposite direction
-            // to the outer ring, so we need to reverse holes if they are clockwise.
-            int i = 0;
-            foreach (GeoPolygon geoPolygon in geoJsonMultiPolygon.Coordinates)
-            {
-                foreach (LineString ring in geoPolygon.Coordinates)
-                {
-                    PathD contour = [];
-                    foreach (IPosition xy in ring.Coordinates)
-                    {
-                        contour.Add(new PointD(xy.Longitude, xy.Latitude));
-                    }
-
-                    if (!ring.IsClosed())
-                    {
-                        contour.Add(contour[0]);
-                    }
-
-                    // Assume all polygons following the initial one are holes.
-                    // If the area of the contour is positive, we must reverse it.
-                    if (i > 0 && Clipper.Area(contour) > 0)
-                    {
-                        contour.Reverse();
-                    }
-
-                    polygon.Add(contour);
-                    i++;
-                }
-            }
-
-            return polygon;
-        }
-
-        throw new InvalidOperationException("Unsupported geometry type.");
-    }
 }

tests/PolygonClipper.Tests/TestPolygonUtilities.cs

@@ -1,7 +1,6 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
 
-using Clipper2Lib;
 using GeoJSON.Text.Feature;
 using PolygonClipper.Tests.TestCases;
 using Xunit;
@@ -12,6 +11,9 @@ public class TestPolygonUtilitiesTests
 {
     private static readonly FeatureCollection Data = TestData.Generic.GetFeatureCollection("issue71.geojson");
 
+    /// <summary>
+    /// Static to allow profiling in Rider.
+    /// </summary>
     private static readonly (Polygon subject, Polygon clipping) Polygons = TestPolygonUtilities.BuildPolygon(Data);
 
     [Fact]
@@ -33,51 +35,13 @@ public void ConvertToPolygon_ValidGeometry_ReturnsPolygon()
     }
 
     [Fact]
-    public void ConvertToClipper2Polygon_ValidGeometry_ReturnsPathsD()
+    public void PolygonClipper_Union_Profile_Test()
     {
-        (PathsD subject, PathsD clipping) = TestPolygonUtilities.BuildClipper2Polygon(Data);
-
-        Assert.NotNull(subject);
-        Assert.NotNull(clipping);
-        Assert.IsType<PathsD>(subject);
-        Assert.IsType<PathsD>(clipping);
-
-        Assert.Equal(2, subject.Count);
-        Assert.Equal(122, subject[0].Count);
-        Assert.Equal(9, subject[1].Count);
-
-        Assert.Single(clipping);
-        Assert.Equal(12, clipping[0].Count);
-    }
-
-    [Fact]
-    public void PolygonClipper_Union_ValidPolygons_ReturnsCorrectResult()
-    {
-        //(Polygon subject, Polygon clipping) = TestPolygonUtilities.BuildPolygon(Data);
-
         Polygon solution = PolygonClipper.Union(Polygons.subject, Polygons.clipping);
         Assert.NotNull(solution);
 
         Assert.Equal(2, solution.ContourCount);
         Assert.Equal(122, solution[0].VertexCount);
         Assert.Equal(9, solution[1].VertexCount);
     }
-
-    [Fact]
-    public void Clipper2_Union_ValidPolygons_ReturnsCorrectResult()
-    {
-        (PathsD subject, PathsD clipping) = TestPolygonUtilities.BuildClipper2Polygon(Data);
-
-        PathsD solution = [];
-        ClipperD clipper2 = new();
-        clipper2.AddSubject(subject);
-        clipper2.AddClip(clipping);
-        Assert.True(clipper2.Execute(ClipType.Union, FillRule.Positive, solution));
-
-        // Clipper2 does not duplicate the first vertex of the each contour
-        // for closed polygons, so we need to adjust the expected counts.
-        Assert.Equal(2, solution.Count);
-        Assert.Equal(121, solution[0].Count);
-        Assert.Equal(8, solution[1].Count);
-    }
 }