Merge pull request #93 from kirillgarbar/scan

Improved scan performance
SparseLinearAlgebra · May 10, 2024 · 108c45c · 108c45c
2 parents 2f5ba61 + b5ea523
commit 108c45c
Show file tree

Hide file tree

Showing 9 changed files with 330 additions and 41 deletions.
diff --git a/src/GraphBLAS-sharp.Backend/Common/ClArray.fs b/src/GraphBLAS-sharp.Backend/Common/ClArray.fs
@@ -202,15 +202,15 @@ module ClArray =
             Bitmap.lastOccurrence clContext workGroupSize
 
         let prefixSumExclude =
-            PrefixSum.runExcludeInPlace <@ (+) @> clContext workGroupSize
+            ScanInternal.standardExcludeInPlace clContext workGroupSize
 
         fun (processor: MailboxProcessor<_>) (inputArray: ClArray<'a>) ->
 
             let bitmap =
                 getUniqueBitmap processor DeviceOnly inputArray
 
             let resultLength =
-                (prefixSumExclude processor bitmap 0)
+                (prefixSumExclude processor bitmap)
                     .ToHostAndFree(processor)
 
             let outputArray =
@@ -314,7 +314,7 @@ module ClArray =
             Map.map<'a, int> (Map.chooseBitmap predicate) clContext workGroupSize
 
         let prefixSum =
-            PrefixSum.standardExcludeInPlace clContext workGroupSize
+            ScanInternal.standardExcludeInPlace clContext workGroupSize
 
         let assignValues =
             assignOption predicate clContext workGroupSize
@@ -410,7 +410,7 @@ module ClArray =
             Map.map2<'a, 'b, int> (Map.choose2Bitmap predicate) clContext workGroupSize
 
         let prefixSum =
-            PrefixSum.standardExcludeInPlace clContext workGroupSize
+            ScanInternal.standardExcludeInPlace clContext workGroupSize
 
         let assignValues =
             assignOption2 predicate clContext workGroupSize
@@ -878,7 +878,7 @@ module ClArray =
             mapInPlace ArithmeticOperations.intNotQ clContext workGroupSize
 
         let prefixSum =
-            PrefixSum.standardExcludeInPlace clContext workGroupSize
+            ScanInternal.standardExcludeInPlace clContext workGroupSize
 
         let scatter =
             Scatter.lastOccurrence clContext workGroupSize

diff --git a/src/GraphBLAS-sharp.Backend/Common/Common.fs b/src/GraphBLAS-sharp.Backend/Common/Common.fs
@@ -211,7 +211,7 @@ module Common =
         /// <param name="workGroupSize">Should be a power of 2 and greater than 1.</param>
         /// <param name="plus">Associative binary operation.</param>
         /// <param name="zero">Zero element for binary operation.</param>
-        let runExcludeInPlace plus = PrefixSum.runExcludeInPlace plus
+        let runExcludeInPlace plus = ScanInternal.runExcludeInPlace plus
 
         /// <summary>
         /// Include in-place prefix sum.
@@ -231,7 +231,8 @@ module Common =
         /// <param name="clContext">ClContext.</param>
         /// <param name="workGroupSize">Should be a power of 2 and greater than 1.</param>
         /// <param name="zero">Zero element for binary operation.</param>
-        let runIncludeInPlace plus = PrefixSum.runIncludeInPlace plus
+        let runIncludeInPlace plus =
+            PrefixSumInternal.runIncludeInPlace plus
 
         /// <summary>
         /// Exclude in-place prefix sum. Array is scanned starting from the end.
@@ -241,7 +242,7 @@ module Common =
         /// <param name="workGroupSize">Should be a power of 2 and greater than 1.</param>
         /// <param name="zero">Zero element for binary operation.</param>
         let runBackwardsExcludeInPlace plus =
-            PrefixSum.runBackwardsExcludeInPlace plus
+            PrefixSumInternal.runBackwardsExcludeInPlace plus
 
         /// <summary>
         /// Include in-place prefix sum. Array is scanned starting from the end.
@@ -251,7 +252,7 @@ module Common =
         /// <param name="workGroupSize">Should be a power of 2 and greater than 1.</param>
         /// <param name="zero">Zero element for binary operation.</param>
         let runBackwardsIncludeInPlace plus =
-            PrefixSum.runBackwardsIncludeInPlace plus
+            PrefixSumInternal.runBackwardsIncludeInPlace plus
 
         /// <summary>
         /// Exclude in-place prefix sum of integer array with addition operation and start value that is equal to 0.
@@ -267,7 +268,7 @@ module Common =
         /// > val sum = [| 4 |]
         /// </code>
         /// </example>
-        let standardExcludeInPlace = PrefixSum.standardExcludeInPlace
+        let standardExcludeInPlace = ScanInternal.standardExcludeInPlace
 
         /// <summary>
         /// Include in-place prefix sum of integer array with addition operation and start value that is equal to 0.
@@ -285,7 +286,7 @@ module Common =
         /// </example>
         /// <param name="clContext">ClContext.</param>
         /// <param name="workGroupSize">Should be a power of 2 and greater than 1.</param>
-        let standardIncludeInPlace = PrefixSum.standardIncludeInPlace
+        let standardIncludeInPlace = PrefixSumInternal.standardIncludeInPlace
 
         module ByKey =
             /// <summary>
@@ -299,7 +300,8 @@ module Common =
             /// > val result = [| 0; 0; 1; 2; 0; 1 |]
             /// </code>
             /// </example>
-            let sequentialExclude op = PrefixSum.ByKey.sequentialExclude op
+            let sequentialExclude op =
+                PrefixSumInternal.ByKey.sequentialExclude op
 
             /// <summary>
             /// Include scan by key.
@@ -312,7 +314,8 @@ module Common =
             /// > val result = [| 1; 1; 2; 3; 1; 2 |]
             /// </code>
             /// </example>
-            let sequentialInclude op = PrefixSum.ByKey.sequentialInclude op
+            let sequentialInclude op =
+                PrefixSumInternal.ByKey.sequentialInclude op
 
     module Reduce =
         /// <summary>

diff --git a/src/GraphBLAS-sharp.Backend/Common/PrefixSum.fs b/src/GraphBLAS-sharp.Backend/Common/PrefixSum.fs
@@ -6,7 +6,7 @@ open GraphBLAS.FSharp.Backend.Quotes
 open GraphBLAS.FSharp.Objects.ArraysExtensions
 open GraphBLAS.FSharp.Objects.ClCellExtensions
 
-module PrefixSum =
+module internal PrefixSumInternal =
     let private update (opAdd: Expr<'a -> 'a -> 'a>) (clContext: ClContext) workGroupSize =
 
         let update =
@@ -224,6 +224,8 @@ module PrefixSum =
     /// </example>
     /// <param name="clContext">ClContext.</param>
     /// <param name="workGroupSize">Should be a power of 2 and greater than 1.</param>
+    [<System.ObsoleteAttribute("This method is deprecated due to bad perfomance. Use method from Scan module instead.",
+                               false)>]
     let standardExcludeInPlace (clContext: ClContext) workGroupSize =
 
         let scan =