Updated build file

.github/workflows/release.yml

@@ -24,32 +24,34 @@ jobs:
         dotnet-version: 8.0.x
         
     - name: Restore dependencies
-      run: dotnet restore HPPH
+      run: dotnet restore
       
     - name: Build
-      run: dotnet build HPPH --no-restore --configuration Release /p:Version=${{ github.event.inputs.version }}
+      run: dotnet build --no-restore --configuration Release /p:Version=${{ github.event.inputs.version }}
       
     - name: Test
-      run: dotnet test HPPH --no-build --verbosity normal --configuration Release
+      run: dotnet test --no-build --verbosity normal --configuration Release
 
+    - name: List files
+      run: tree
+      
     - name: Upload Nuget Build Artifact
       uses: actions/upload-artifact@v4.3.1
       with:
         name: HPPH-Nuget
-        path: HPPH\bin\Release\*.nupkg
+        path: bin\*.nupkg
         if-no-files-found: error
 
-    - name: List files
-      run: tree
-
     - name: Release
       uses: softprops/action-gh-release@v2.0.4
       with:
         tag_name: ${{ github.event.inputs.version }}
         generate_release_notes: true
-        files: HPPH/bin/Release/net8.0/*.dll
+        files: bin/net8.0/*.dll
                   
     - name: Nuget Push
-      id: nuget_push
       run: dotnet nuget push **\*.nupkg --skip-duplicate --api-key ${{ secrets.NUGET_TOKEN }} --source https://api.nuget.org/v3/index.json
+      
+    - name: Symbols Push
+      run: dotnet nuget push **\*.snupkg --skip-duplicate --api-key ${{ secrets.NUGET_TOKEN }} --source https://api.nuget.org/v3/index.json
      

HPPH.Benchmark/AverageBenchmarks.cs

@@ -0,0 +1,72 @@
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Jobs;
+using HPPH.Reference;
+
+namespace HPPH.Benchmark;
+
+[SimpleJob(RuntimeMoniker.Net80)]
+[HtmlExporter]
+[MemoryDiagnoser]
+public class AverageBenchmarks
+{
+    #region Properties & Fields
+
+    private readonly List<ColorRGB[]> _colors3bpp;
+    private readonly List<ColorRGBA[]> _colors4bpp;
+
+    #endregion
+
+    #region Constructors
+
+    public AverageBenchmarks()
+    {
+        _colors3bpp = BenchmarkHelper.GetSampleData<ColorRGB>();
+        _colors4bpp = BenchmarkHelper.GetSampleData<ColorRGBA>();
+    }
+
+    #endregion
+
+    #region Methods
+
+    [Benchmark]
+    public ColorRGB[] PixelHelper_3BPP()
+    {
+        ColorRGB[] averages = new ColorRGB[_colors3bpp.Count];
+        for (int i = 0; i < _colors3bpp.Count; i++)
+            averages[i] = new ReadOnlySpan<ColorRGB>(_colors3bpp[i]).Average();
+
+        return averages;
+    }
+
+    [Benchmark]
+    public ColorRGBA[] PixelHelper_4BPP()
+    {
+        ColorRGBA[] averages = new ColorRGBA[_colors4bpp.Count];
+        for (int i = 0; i < _colors4bpp.Count; i++)
+            averages[i] = new ReadOnlySpan<ColorRGBA>(_colors4bpp[i]).Average();
+
+        return averages;
+    }
+
+    [Benchmark]
+    public ColorRGB[] Reference_3BPP()
+    {
+        ColorRGB[] averages = new ColorRGB[_colors3bpp.Count];
+        for (int i = 0; i < _colors3bpp.Count; i++)
+            averages[i] = ReferencePixelHelper.Average(new ReadOnlySpan<ColorRGB>(_colors3bpp[i]));
+
+        return averages;
+    }
+
+    [Benchmark]
+    public ColorRGBA[] Reference_4BPP()
+    {
+        ColorRGBA[] averages = new ColorRGBA[_colors4bpp.Count];
+        for (int i = 0; i < _colors4bpp.Count; i++)
+            averages[i] = ReferencePixelHelper.Average(new ReadOnlySpan<ColorRGBA>(_colors4bpp[i]));
+
+        return averages;
+    }
+
+    #endregion
+}

HPPH.Benchmark/BenchmarkHelper.cs

@@ -0,0 +1,22 @@
+using HPPH.System.Drawing;
+
+namespace HPPH.Benchmark;
+
+internal static class BenchmarkHelper
+{
+    private const string SAMPLE_DATA_DIR = @"..\..\..\..\..\..\..\..\sample_data";
+
+    public static List<T[]> GetSampleData<T>()
+        where T : struct, IColor
+    {
+        if (!Directory.Exists(SAMPLE_DATA_DIR)) throw new Exception("sample data not found!");
+
+        List<T[]> colors = [];
+
+        IEnumerable<string> files = Directory.EnumerateFiles(SAMPLE_DATA_DIR, "*.png", SearchOption.AllDirectories);
+        foreach (string file in files)
+            colors.Add(ImageHelper.LoadImage(file).ConvertTo<T>().ToArray());
+
+        return colors;
+    }
+}

HPPH.Benchmark/ConvertBenchmarks.cs

@@ -1,6 +1,5 @@
 using BenchmarkDotNet.Attributes;
 using BenchmarkDotNet.Jobs;
-using HPPH.System.Drawing;
 
 namespace HPPH.Benchmark;
 
@@ -11,7 +10,8 @@ public class ConvertBenchmarks
 {
     #region Properties & Fields
 
-    private readonly List<ColorRGB[]> _colors = [];
+    private readonly List<ColorRGB[]> _colors3bpp;
+    private readonly List<ColorRGBA[]> _colors4bpp;
 
     #endregion
 
@@ -19,13 +19,8 @@ public class ConvertBenchmarks
 
     public ConvertBenchmarks()
     {
-        if (!Directory.Exists(@"..\..\..\..\sample_data")) return;
-
-        _colors = [];
-
-        IEnumerable<string> files = Directory.EnumerateFiles(@"..\..\..\..\sample_data", "*.png", SearchOption.AllDirectories);
-        foreach (string file in files)
-            _colors.Add(ImageHelper.LoadImage(file).AsRefImage<ColorRGB>().ToArray());
+        _colors3bpp = BenchmarkHelper.GetSampleData<ColorRGB>();
+        _colors4bpp = BenchmarkHelper.GetSampleData<ColorRGBA>();
     }
 
     #endregion
@@ -36,10 +31,8 @@ public class ConvertBenchmarks
     public ColorBGR[] RGBToBGR()
     {
         ColorBGR[] result = [];
-        foreach (ColorRGB[] color in _colors)
-        {
+        foreach (ColorRGB[] color in _colors3bpp)
             result = new ReadOnlySpan<ColorRGB>(color).Convert<ColorRGB, ColorBGR>();
-        }
 
         return result;
     }
@@ -48,11 +41,45 @@ public class ConvertBenchmarks
     public ColorBGRA[] RGBToBGRA()
     {
         ColorBGRA[] result = [];
-        foreach (ColorRGB[] color in _colors)
+        foreach (ColorRGB[] color in _colors3bpp)
             result = new ReadOnlySpan<ColorRGB>(color).Convert<ColorRGB, ColorBGRA>();
 
         return result;
     }
 
+    [Benchmark]
+    public ColorABGR[] RGBAToABGR()
+    {
+        ColorABGR[] result = [];
+        foreach (ColorRGBA[] color in _colors4bpp)
+            result = new ReadOnlySpan<ColorRGBA>(color).Convert<ColorRGBA, ColorABGR>();
+
+        return result;
+    }
+
+    [Benchmark]
+    public ColorBGR[] ARGBToBGR()
+    {
+        ColorBGR[] result = [];
+        foreach (ColorRGBA[] color in _colors4bpp)
+            result = new ReadOnlySpan<ColorRGBA>(color).Convert<ColorRGBA, ColorBGR>();
+
+        return result;
+    }
+
+    [Benchmark]
+    public void RGBToBGR_InPlace()
+    {
+        foreach (ColorRGB[] color in _colors3bpp)
+            new Span<ColorRGB>(color).ConvertInPlace<ColorRGB, ColorBGR>();
+    }
+
+    [Benchmark]
+    public void RGBAToABGR_InPlace()
+    {
+        foreach (ColorRGBA[] color in _colors4bpp)
+            new Span<ColorRGBA>(color).ConvertInPlace<ColorRGBA, ColorABGR>();
+    }
+
     #endregion
 }

HPPH.Benchmark/MinMaxBenchmarks.cs

@@ -0,0 +1,72 @@
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Jobs;
+using HPPH.Reference;
+
+namespace HPPH.Benchmark;
+
+[SimpleJob(RuntimeMoniker.Net80)]
+[HtmlExporter]
+[MemoryDiagnoser]
+public class MinMaxBenchmarks
+{
+    #region Properties & Fields
+
+    private readonly List<ColorRGB[]> _colors3bpp;
+    private readonly List<ColorRGBA[]> _colors4bpp;
+
+    #endregion
+
+    #region Constructors
+
+    public MinMaxBenchmarks()
+    {
+        _colors3bpp = BenchmarkHelper.GetSampleData<ColorRGB>();
+        _colors4bpp = BenchmarkHelper.GetSampleData<ColorRGBA>();
+    }
+
+    #endregion
+
+    #region Methods
+
+    [Benchmark]
+    public IMinMax[] PixelHelper_3BPP()
+    {
+        IMinMax[] minMax = new IMinMax[_colors3bpp.Count];
+        for (int i = 0; i < _colors3bpp.Count; i++)
+            minMax[i] = new ReadOnlySpan<ColorRGB>(_colors3bpp[i]).MinMax();
+
+        return minMax;
+    }
+
+    [Benchmark]
+    public IMinMax[] PixelHelper_4BPP()
+    {
+        IMinMax[] minMax = new IMinMax[_colors4bpp.Count];
+        for (int i = 0; i < _colors4bpp.Count; i++)
+            minMax[i] = new ReadOnlySpan<ColorRGBA>(_colors4bpp[i]).MinMax();
+
+        return minMax;
+    }
+
+    [Benchmark]
+    public IMinMax[] Reference_3BPP()
+    {
+        IMinMax[] minMax = new IMinMax[_colors3bpp.Count];
+        for (int i = 0; i < _colors3bpp.Count; i++)
+            minMax[i] = ReferencePixelHelper.MinMax(new ReadOnlySpan<ColorRGB>(_colors3bpp[i]));
+
+        return minMax;
+    }
+
+    [Benchmark]
+    public IMinMax[] Reference_4BPP()
+    {
+        IMinMax[] minMax = new IMinMax[_colors4bpp.Count];
+        for (int i = 0; i < _colors4bpp.Count; i++)
+            minMax[i] = ReferencePixelHelper.MinMax(new ReadOnlySpan<ColorRGBA>(_colors4bpp[i]));
+
+        return minMax;
+    }
+
+    #endregion
+}

HPPH.Benchmark/Program.cs

@@ -1,4 +1,4 @@
 using BenchmarkDotNet.Running;
 using HPPH.Benchmark;
 
-BenchmarkRunner.Run<ConvertBenchmarks>();
+BenchmarkRunner.Run(typeof(Program).Assembly);

HPPH.Benchmark/SortBenchmarks.cs

@@ -0,0 +1,60 @@
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Jobs;
+using HPPH.Reference;
+
+namespace HPPH.Benchmark;
+
+[SimpleJob(RuntimeMoniker.Net80)]
+[HtmlExporter]
+[MemoryDiagnoser]
+public class SortBenchmarks
+{
+    #region Properties & Fields
+
+    private readonly List<ColorRGB[]> _colors3bpp;
+    private readonly List<ColorRGBA[]> _colors4bpp;
+
+    #endregion
+
+    #region Constructors
+
+    public SortBenchmarks()
+    {
+        _colors3bpp = BenchmarkHelper.GetSampleData<ColorRGB>();
+        _colors4bpp = BenchmarkHelper.GetSampleData<ColorRGBA>();
+    }
+
+    #endregion
+
+    #region Methods
+
+    [Benchmark]
+    public void PixelHelper_3BPP()
+    {
+        foreach (ColorRGB[] colors in _colors3bpp)
+            new Span<ColorRGB>(colors).SortByRed();
+    }
+
+    [Benchmark]
+    public void PixelHelper_4BPP()
+    {
+        foreach (ColorRGBA[] colors in _colors4bpp)
+            new Span<ColorRGBA>(colors).SortByRed();
+    }
+
+    [Benchmark]
+    public void Reference_3BPP()
+    {
+        foreach (ColorRGB[] colors in _colors3bpp)
+            ReferencePixelHelper.SortByRed(new Span<ColorRGB>(colors));
+    }
+
+    [Benchmark]
+    public void Reference_4BPP()
+    {
+        foreach (ColorRGBA[] colors in _colors4bpp)
+            ReferencePixelHelper.SortByRed(new Span<ColorRGBA>(colors));
+    }
+
+    #endregion
+}

HPPH.Benchmark/SumBenchmarks.cs

@@ -0,0 +1,72 @@
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Jobs;
+using HPPH.Reference;
+
+namespace HPPH.Benchmark;
+
+[SimpleJob(RuntimeMoniker.Net80)]
+[HtmlExporter]
+[MemoryDiagnoser]
+public class SumBenchmarks
+{
+    #region Properties & Fields
+
+    private readonly List<ColorRGB[]> _colors3bpp;
+    private readonly List<ColorRGBA[]> _colors4bpp;
+
+    #endregion
+
+    #region Constructors
+
+    public SumBenchmarks()
+    {
+        _colors3bpp = BenchmarkHelper.GetSampleData<ColorRGB>();
+        _colors4bpp = BenchmarkHelper.GetSampleData<ColorRGBA>();
+    }
+
+    #endregion
+
+    #region Methods
+
+    [Benchmark]
+    public ISum[] PixelHelper_3BPP()
+    {
+        ISum[] sums = new ISum[_colors3bpp.Count];
+        for (int i = 0; i < _colors3bpp.Count; i++)
+            sums[i] = new ReadOnlySpan<ColorRGB>(_colors3bpp[i]).Sum();
+
+        return sums;
+    }
+
+    [Benchmark]
+    public ISum[] PixelHelper_4BPP()
+    {
+        ISum[] sums = new ISum[_colors4bpp.Count];
+        for (int i = 0; i < _colors4bpp.Count; i++)
+            sums[i] = new ReadOnlySpan<ColorRGBA>(_colors4bpp[i]).Sum();
+
+        return sums;
+    }
+
+    [Benchmark]
+    public ISum[] Reference_3BPP()
+    {
+        ISum[] sums = new ISum[_colors3bpp.Count];
+        for (int i = 0; i < _colors3bpp.Count; i++)
+            sums[i] = ReferencePixelHelper.Sum(new ReadOnlySpan<ColorRGB>(_colors3bpp[i]));
+
+        return sums;
+    }
+
+    [Benchmark]
+    public ISum[] Reference_4BPP()
+    {
+        ISum[] sums = new ISum[_colors4bpp.Count];
+        for (int i = 0; i < _colors4bpp.Count; i++)
+            sums[i] = ReferencePixelHelper.Sum(new ReadOnlySpan<ColorRGBA>(_colors4bpp[i]));
+
+        return sums;
+    }
+
+    #endregion
+}

HPPH.Generators/ColorSortSourceGenerator.cs

@@ -15,6 +15,8 @@ public class ColorSortSourceGenerator : IIncrementalGenerator
     #region Properties & Fields
 
     private const string SORT_GENERATOR_ATTRIBUTE_SOURCE = """
+                                                            #nullable enable
+                                                            
                                                             namespace HPPH;
                                                             
                                                             [AttributeUsage(AttributeTargets.Method)]
@@ -79,6 +81,8 @@ public class ColorSortSourceGenerator : IIncrementalGenerator
         foreach (KeyValuePair<(string @namespace, string @class, string classModifier), string> data in sourceMapping)
         {
             context.AddSource($"{data.Key.@class}.g.cs", SourceText.From($$"""
+                                                                           #nullable enable
+                                                                           
                                                                            using System.Buffers;
                                                                            
                                                                            namespace {{data.Key.@namespace}};

HPPH.Generators/Features/Average.cs

@@ -18,6 +18,8 @@ internal class Average : IGeneratorFeature
     private static string GenerateColorFormatAverage(ColorFormatData colorFormat)
     {
         return $$"""
+                 #nullable enable
+                 
                  using System.Runtime.InteropServices;
                  
                  namespace HPPH;
@@ -36,6 +38,8 @@ internal class Average : IGeneratorFeature
     private static string GenerateColorFormatInterfaceAverage()
     {
         return """
+               #nullable enable
+               
                namespace HPPH;
                
                public partial interface IColorFormat

HPPH.Generators/Features/Colors.cs

@@ -25,6 +25,8 @@ internal class Colors : IGeneratorFeature
      => colorFormat.Bpp switch
      {
          3 => $$"""
+                #nullable enable
+                
                 // ReSharper disable ConvertToAutoProperty
                 // ReSharper disable ConvertToAutoPropertyWhenPossible
                 // ReSharper disable ReplaceWithPrimaryConstructorParameter
@@ -89,6 +91,8 @@ internal class Colors : IGeneratorFeature
                 """,
 
          4 => $$"""
+                #nullable enable
+                
                 // ReSharper disable ConvertToAutoProperty
                 // ReSharper disable ConvertToAutoPropertyWhenPossible
                 // ReSharper disable ReplaceWithPrimaryConstructorParameter
@@ -159,6 +163,8 @@ internal class Colors : IGeneratorFeature
     private static string GenerateColorFormatCode(ColorFormatData colorFormat)
     {
         return $$"""
+                 #nullable enable
+                 
                  namespace HPPH;
 
                  public sealed partial class ColorFormat{{colorFormat.Format}} : IColorFormat
@@ -188,6 +194,8 @@ internal class Colors : IGeneratorFeature
     {
         StringBuilder sb = new();
         sb.AppendLine("""
+                      #nullable enable
+                      
                       namespace HPPH;
 
                       public partial interface IColorFormat

HPPH.Generators/Features/MinMax.cs

@@ -20,6 +20,8 @@ internal class MinMax : IGeneratorFeature
      => colorFormat.Bpp switch
      {
          3 => $$"""
+                 #nullable enable
+                 
                  // ReSharper disable ConvertToAutoProperty
                  // ReSharper disable ReplaceWithPrimaryConstructorParameter
                  
@@ -73,6 +75,8 @@ internal class MinMax : IGeneratorFeature
                  """,
 
          4 => $$"""
+                #nullable enable
+                
                 // ReSharper disable ConvertToAutoProperty
                 // ReSharper disable ReplaceWithPrimaryConstructorParameter
                 
@@ -133,6 +137,8 @@ internal class MinMax : IGeneratorFeature
     private static string GenerateColorFormatMinMax(ColorFormatData colorFormat)
     {
         return $$"""
+                 #nullable enable
+                 
                  using System.Runtime.InteropServices;
                  
                  namespace HPPH;
@@ -151,6 +157,8 @@ internal class MinMax : IGeneratorFeature
     private static string GenerateColorFormatInterfaceMinMax()
     {
         return """
+               #nullable enable
+               
                namespace HPPH;
                
                public partial interface IColorFormat

HPPH.Generators/Features/Quantize.cs

@@ -18,6 +18,8 @@ internal class Quantize : IGeneratorFeature
     private static string GenerateColorFormatQuantize(ColorFormatData colorFormat)
     {
         return $$"""
+                 #nullable enable
+                 
                  using System.Runtime.InteropServices;
                  
                  namespace HPPH;
@@ -56,6 +58,8 @@ internal class Quantize : IGeneratorFeature
     private static string GenerateColorFormatInterfaceQuantize()
     {
         return """
+               #nullable enable
+               
                namespace HPPH;
                
                public partial interface IColorFormat

HPPH.Generators/Features/Sum.cs

@@ -20,6 +20,8 @@ internal class Sum : IGeneratorFeature
      => colorFormat.Bpp switch
      {
          3 => $$"""
+                #nullable enable
+                
                 // ReSharper disable ConvertToAutoProperty
                 // ReSharper disable ConvertToAutoPropertyWhenPossible
                 // ReSharper disable ReplaceWithPrimaryConstructorParameter
@@ -58,6 +60,8 @@ internal class Sum : IGeneratorFeature
                 """,
 
          4 => $$"""
+                #nullable enable
+                
                 // ReSharper disable ConvertToAutoProperty
                 // ReSharper disable ConvertToAutoPropertyWhenPossible
                 // ReSharper disable ReplaceWithPrimaryConstructorParameter
@@ -100,6 +104,8 @@ internal class Sum : IGeneratorFeature
     private static string GenerateColorFormatSum(ColorFormatData colorFormat)
     {
         return $$"""
+                 #nullable enable
+                 
                  using System.Runtime.InteropServices;
                  
                  namespace HPPH;
@@ -118,6 +124,8 @@ internal class Sum : IGeneratorFeature
     private static string GenerateColorFormatInterfaceSum()
     {
         return """
+               #nullable enable
+               
                namespace HPPH;
                
                public partial interface IColorFormat

HPPH.Reference/PixelHelper.Quantize.cs

@@ -97,10 +97,10 @@ internal class ColorCube
         int b = _colors.Sum(x => x.B);
         int a = _colors.Sum(x => x.A);
 
-        return T.Create((byte)(r / _colors.Count),
-                        (byte)(g / _colors.Count),
-                        (byte)(b / _colors.Count),
-                        (byte)(a / _colors.Count));
+        return T.Create((byte)MathF.Round(r / (float)_colors.Count),
+                        (byte)MathF.Round(g / (float)_colors.Count),
+                        (byte)MathF.Round(b / (float)_colors.Count),
+                        (byte)MathF.Round(a / (float)_colors.Count));
     }
 
     #endregion

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSortSourceGenerator/ColorSortGeneratorAttribute.g.cs

@@ -1,4 +1,6 @@
-namespace HPPH;
+#nullable enable
+
+namespace HPPH;
 
 [AttributeUsage(AttributeTargets.Method)]
 internal class ColorSortGeneratorAttribute(string dataTypeName, string sortValueName) : Attribute

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSortSourceGenerator/PixelHelper.g.cs

@@ -1,4 +1,6 @@
-using System.Buffers;
+#nullable enable
+
+using System.Buffers;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorABGR.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ConvertToAutoPropertyWhenPossible
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorARGB.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ConvertToAutoPropertyWhenPossible
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorBGR.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ConvertToAutoPropertyWhenPossible
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorBGRA.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ConvertToAutoPropertyWhenPossible
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatABGR.Average.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatABGR.MinMax.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatABGR.Quantize.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatABGR.Sum.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatABGR.g.cs

@@ -1,4 +1,6 @@
-namespace HPPH;
+#nullable enable
+
+namespace HPPH;
 
 public sealed partial class ColorFormatABGR : IColorFormat
 {

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatARGB.Average.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatARGB.MinMax.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatARGB.Quantize.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatARGB.Sum.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatARGB.g.cs

@@ -1,4 +1,6 @@
-namespace HPPH;
+#nullable enable
+
+namespace HPPH;
 
 public sealed partial class ColorFormatARGB : IColorFormat
 {

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatBGR.Average.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatBGR.MinMax.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatBGR.Quantize.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatBGR.Sum.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatBGR.g.cs

@@ -1,4 +1,6 @@
-namespace HPPH;
+#nullable enable
+
+namespace HPPH;
 
 public sealed partial class ColorFormatBGR : IColorFormat
 {

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatBGRA.Average.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatBGRA.MinMax.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatBGRA.Quantize.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatBGRA.Sum.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatBGRA.g.cs

@@ -1,4 +1,6 @@
-namespace HPPH;
+#nullable enable
+
+namespace HPPH;
 
 public sealed partial class ColorFormatBGRA : IColorFormat
 {

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatRGB.Average.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatRGB.MinMax.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatRGB.Quantize.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatRGB.Sum.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatRGB.g.cs

@@ -1,4 +1,6 @@
-namespace HPPH;
+#nullable enable
+
+namespace HPPH;
 
 public sealed partial class ColorFormatRGB : IColorFormat
 {

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatRGBA.Average.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatRGBA.MinMax.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatRGBA.Quantize.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatRGBA.Sum.g.cs

@@ -1,4 +1,6 @@
-using System.Runtime.InteropServices;
+#nullable enable
+
+using System.Runtime.InteropServices;
 
 namespace HPPH;
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorFormatRGBA.g.cs

@@ -1,4 +1,6 @@
-namespace HPPH;
+#nullable enable
+
+namespace HPPH;
 
 public sealed partial class ColorFormatRGBA : IColorFormat
 {

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorRGB.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ConvertToAutoPropertyWhenPossible
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/ColorRGBA.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ConvertToAutoPropertyWhenPossible
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/IColorFormat.Average.g.cs

@@ -1,4 +1,6 @@
-namespace HPPH;
+#nullable enable
+
+namespace HPPH;
 
 public partial interface IColorFormat
 {

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/IColorFormat.Instances.g.cs

@@ -1,4 +1,6 @@
-namespace HPPH;
+#nullable enable
+
+namespace HPPH;
 
 public partial interface IColorFormat
 {

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/IColorFormat.MinMax.g.cs

@@ -1,4 +1,6 @@
-namespace HPPH;
+#nullable enable
+
+namespace HPPH;
 
 public partial interface IColorFormat
 {

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/IColorFormat.Quantize.g.cs

@@ -1,4 +1,6 @@
-namespace HPPH;
+#nullable enable
+
+namespace HPPH;
 
 public partial interface IColorFormat
 {

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/IColorFormat.Sum.g.cs

@@ -1,4 +1,6 @@
-namespace HPPH;
+#nullable enable
+
+namespace HPPH;
 
 public partial interface IColorFormat
 {

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/MinMaxABGR.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 
 using System.Diagnostics;

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/MinMaxARGB.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 
 using System.Diagnostics;

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/MinMaxBGR.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 
 using System.Diagnostics;

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/MinMaxBGRA.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 
 using System.Diagnostics;

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/MinMaxRGB.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 
 using System.Diagnostics;

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/MinMaxRGBA.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 
 using System.Diagnostics;

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/SumABGR.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ConvertToAutoPropertyWhenPossible
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/SumARGB.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ConvertToAutoPropertyWhenPossible
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/SumBGR.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ConvertToAutoPropertyWhenPossible
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/SumBGRA.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ConvertToAutoPropertyWhenPossible
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/SumRGB.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ConvertToAutoPropertyWhenPossible
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 

HPPH/Generated/HPPH.Generators/HPPH.Generators.ColorSourceGenerator/SumRGBA.g.cs

@@ -1,4 +1,6 @@
-// ReSharper disable ConvertToAutoProperty
+#nullable enable
+
+// ReSharper disable ConvertToAutoProperty
 // ReSharper disable ConvertToAutoPropertyWhenPossible
 // ReSharper disable ReplaceWithPrimaryConstructorParameter
 

README.md

@@ -1,3 +1,105 @@
-# HPPH
+# HPPH
 
-**WIP**
+C# High Performance Pixel Handling 
+
+
+## Summary
+
+This library contains helpers to work with color data (currently only 24 and 32 bit byte data) in a somewhat performance-optimized fully in C#.   
+
+It consists of the following packages:
+
+| Package                                                                   | Description                                                                    |
+|---------------------------------------------------------------------------|--------------------------------------------------------------------------------|
+| [HPPH](https://www.nuget.org/packages/HPPH)                               | Core-package, containg all the features described below                        |
+| [HPPH.System.Drawing](https://www.nuget.org/packages/HPPH.System.Drawing) | Contains extensions to convert Images from and to System.Drawing.Bitmaps       |
+| [HPPH.SkiaSharp](https://www.nuget.org/packages/HPPH.SkiaSharp)           | Contains extensions to convert Images from and to SkiaSharp images and bitmaps |
+
+## Supported Operations
+
+All of the currently supported operations are briefly described below. More are to come.   
+
+Benchmarks are all run on an Ryzen 9 5900X. Reference is always a simple approach like looping over the data performing the operation.    
+The data used is always the full set of sample_data to cover a variaty of images.    
+
+
+### Image
+An abstraction layer for handling pixel-grids.   
+
+Supports all of the operations below and things like allocation-free region selection, iteration and copying of rows, colums or whole images/regions.
+
+
+### Sum
+
+Optimized summarization of colors into 4 longs (one for each channel).
+
+| Method           | Mean       | Error    | StdDev   | Allocated |
+|----------------- |-----------:|---------:|---------:|----------:|
+| PixelHelper_3BPP |   107.3 μs |  0.21 μs |  0.20 μs |     528 B |
+| PixelHelper_4BPP |   167.7 μs |  0.85 μs |  0.71 μs |     528 B |
+| Reference_3BPP   | 1,683.3 μs | 18.87 μs | 17.65 μs |     529 B |
+| Reference_4BPP   | 1,619.5 μs |  9.08 μs |  7.58 μs |     529 B |
+
+
+### Average
+
+Averages some colors into a single color of the same format.
+
+| Method           | Mean       | Error    | StdDev   | Allocated |
+|----------------- |-----------:|---------:|---------:|----------:|
+| PixelHelper_3BPP |   108.2 μs |  0.41 μs |  0.34 μs |      56 B |
+| PixelHelper_4BPP |   169.0 μs |  2.29 μs |  2.14 μs |      64 B |
+| Reference_3BPP   | 1,654.9 μs | 12.06 μs | 11.28 μs |     705 B |
+| Reference_4BPP   | 1,613.4 μs | 21.11 μs | 18.71 μs |     713 B |
+
+
+### Min-Max
+
+Gets the minimum and maximum value for each channel of the given color data.
+
+| Method           | Mean       | Error    | StdDev   | Allocated |
+|----------------- |-----------:|---------:|---------:|----------:|
+| PixelHelper_3BPP |   106.2 μs |  0.38 μs |  0.35 μs |     312 B |
+| PixelHelper_4BPP |   139.2 μs |  1.94 μs |  1.82 μs |     312 B |
+| Reference_3BPP   | 3,838.1 μs | 35.40 μs | 31.38 μs |     314 B |
+| Reference_4BPP   | 4,456.9 μs | 21.06 μs | 19.70 μs |     315 B |
+
+
+### Sort
+
+Sorts color data by a single channel (Red, Green, Blue or Alpha).   
+The algorithm is stable.
+
+> This benchmark is somewhat flawed as it's effectivly running on pre-sorted data, which does not affect the PixelHelper, but might affect the Reference.   
+>
+> It's also using Linq.OrderBy which is not ideal performance-wise and requires some unneccessary allocations to fit the API, but Array/Span.Sort is not stable, which the PixelHelper is so that wouldn't be a fair comparison.)
+
+| Method           | Mean      | Error     | StdDev    | Allocated  |
+|----------------- |----------:|----------:|----------:|-----------:|
+| PixelHelper_3BPP |  4.084 ms | 0.0084 ms | 0.0075 ms |        6 B |
+| PixelHelper_4BPP |  2.687 ms | 0.0102 ms | 0.0091 ms |        3 B |
+| Reference_3BPP   | 59.883 ms | 0.5693 ms | 0.5325 ms | 43118222 B |
+| Reference_4BPP   | 59.599 ms | 0.4866 ms | 0.4551 ms | 52355952 B |
+
+
+### Quantization
+
+Creates a color-palette of a given size for some color-data.   
+Currently only a simple but fast variation using the median-cut algorithm is implemented. It's also limited to sizes being a power of 2.   
+
+A more quality focused implementation without the size limitation is planned.
+
+
+### Conversion
+
+Converts from one color format to another.   
+All of the included formats can freely be converted between each other.   
+
+Allocation-free in-place conversion is only supported for formats of same size (both 24 or 32 bit).
+
+| Method     | Mean     | Error     | StdDev    | Allocated |
+|----------- |---------:|----------:|----------:|----------:|
+| RGBToBGR   | 6.272 ms | 0.0288 ms | 0.0240 ms |   8.81 MB |
+| RGBToBGRA  | 8.534 ms | 0.0684 ms | 0.0640 ms |  11.75 MB |
+| RGBAToABGR | 8.128 ms | 0.0927 ms | 0.0867 ms |  11.75 MB |
+| ARGBToBGR  | 8.004 ms | 0.0353 ms | 0.0313 ms |   8.81 MB |