Constants module and signature for PageRank module

Author: kirillgarbar

benchmarks/GraphBLAS-sharp.Benchmarks/Algorithms/PageRank.fs

@@ -23,11 +23,9 @@ type Benchmarks(
 
     let mutable funToBenchmark = None
     let mutable matrix = Unchecked.defaultof<ClMatrix<float32>>
-    let mutable matrixPrepared = Unchecked.defaultof<PageRankMatrix<float32>>
+    let mutable matrixPrepared = Unchecked.defaultof<Algorithms.PageRank.PageRankMatrix>
     let mutable matrixHost = Unchecked.defaultof<_>
 
-    let accuracy = 0.00000001f
-
     member val Result = Unchecked.defaultof<ClVector<float32>> with get,set
 
     [<ParamsSource("AvailableContexts")>]
@@ -67,7 +65,7 @@ type Benchmarks(
         | Some x -> x
 
     member this.PageRank() =
-        this.Result <- this.FunToBenchmark this.Processor matrixPrepared accuracy
+        this.Result <- this.FunToBenchmark this.Processor matrixPrepared Constants.PageRank.accuracy
 
     member this.ClearInputMatrix() =
         matrix.Dispose this.Processor

src/GraphBLAS-sharp.Backend/Algorithms/Algorithms.fs

@@ -21,11 +21,13 @@ module Algorithms =
         let run = SSSP.run
 
     module PageRank =
+        type PageRankMatrix = PageRank.PageRankMatrix
+
         /// <summary>
         /// Computes PageRank of the given matrix.
         /// Matrix should be prepared in advance using "PageRank.prepareMatrix" method.
         /// Accepts accuracy as a parameter which determines how many iterations will be performed.
-        /// Values of accuracy lower than 1e-06 are not recommended since the process may never stop.
+        /// Values of accuracy higher than 1e-06 are not recommended since the process may never stop.
         /// </summary>
         /// <example>
         /// <code>

src/GraphBLAS-sharp.Backend/Algorithms/PageRank.fs

@@ -11,8 +11,13 @@ open GraphBLAS.FSharp.Objects.ClContextExtensions
 open GraphBLAS.FSharp.Objects.ArraysExtensions
 open GraphBLAS.FSharp.Objects.ClCellExtensions
 
-module internal PageRank =
-    let alpha = 0.85f
+module PageRank =
+    type PageRankMatrix =
+        | PreparedMatrix of ClMatrix<float32>
+
+        member this.Dispose(processor: MailboxProcessor<Msg>) =
+            match this with
+            | PreparedMatrix matrix -> matrix.Dispose processor
 
     let private countOutDegree (clContext: ClContext) workGroupSize =
 
@@ -40,10 +45,10 @@ module internal PageRank =
 
             outDegree
 
-    let prepareMatrix (clContext: ClContext) workGroupSize =
+    let internal prepareMatrix (clContext: ClContext) workGroupSize =
 
         //Passing global variable to kernel in Brahma is not possible
-        let alpha = alpha
+        let alpha = Constants.PageRank.alpha
 
         let op =
             <@ fun (x: float32 option) y ->
@@ -131,10 +136,10 @@ module internal PageRank =
 
                 transposeInPlace queue DeviceOnly newMatrix
                 |> ClMatrix.CSR
-                |> PageRankMatrix
+                |> PreparedMatrix
             | _ -> failwith "Not implemented"
 
-    let run (clContext: ClContext) workGroupSize =
+    let internal run (clContext: ClContext) workGroupSize =
 
         let squareOfDifference = ArithmeticOperations.squareOfDifference
         let plus = ArithmeticOperations.float32SumOption
@@ -155,7 +160,7 @@ module internal PageRank =
         let create =
             GraphBLAS.FSharp.Vector.create clContext workGroupSize
 
-        fun (queue: MailboxProcessor<Msg>) (PageRankMatrix matrix) accuracy ->
+        fun (queue: MailboxProcessor<Msg>) (PreparedMatrix matrix) accuracy ->
             let vertexCount = matrix.RowCount
 
             //None is 0
@@ -169,7 +174,15 @@ module internal PageRank =
                 create queue DeviceOnly vertexCount Dense None
 
             let addition =
-                create queue DeviceOnly vertexCount Dense (Some((1.0f - alpha) / (float32 vertexCount)))
+                create
+                    queue
+                    DeviceOnly
+                    vertexCount
+                    Dense
+                    (Some(
+                        (1.0f - Constants.PageRank.alpha)
+                        / (float32 vertexCount)
+                    ))
 
             let mutable error = accuracy + 0.1f
 
@@ -178,7 +191,7 @@ module internal PageRank =
             while error > accuracy do
                 i <- i + 1
 
-                // rank = matrix*rank + (1 - alpha)/N
+                // rank = matrix*rank + (1 - ALPHA)/N
                 spMVTo queue matrix prevRank rank
                 addToResult queue rank addition
 

src/GraphBLAS-sharp.Backend/Algorithms/PageRank.fsi

@@ -0,0 +1,13 @@
+namespace GraphBLAS.FSharp.Backend.Algorithms
+
+open Brahma.FSharp
+open GraphBLAS.FSharp.Objects
+
+module PageRank =
+    [<Sealed>]
+    type PageRankMatrix =
+        member Dispose : MailboxProcessor<Msg> -> unit
+
+    val internal prepareMatrix : ClContext -> int -> (MailboxProcessor<Msg> -> ClMatrix<float32> -> PageRankMatrix)
+
+    val internal run : ClContext -> int -> (MailboxProcessor<Msg> -> PageRankMatrix -> float32 -> ClVector<float32>)

src/GraphBLAS-sharp.Backend/Common/Utils.fs

@@ -1,7 +1,6 @@
 namespace GraphBLAS.FSharp.Backend.Common
 
 module internal Utils =
-    let defaultWorkGroupSize = 32
 
     let floorToPower2 =
         fun x -> x ||| (x >>> 1)

src/GraphBLAS-sharp.Backend/Constants/Constants.fs

@@ -0,0 +1,18 @@
+namespace GraphBLAS.FSharp
+
+[<RequireQualifiedAccess>]
+module Constants =
+    module PageRank =
+        /// <summary>
+        /// PageRank algorithms will finish then
+        /// difference of current and previous vectors
+        /// is less than accuracy
+        /// </summary>
+        let accuracy = 1e-6f
+        /// <summary>
+        /// Damping factor for PageRank algorithm
+        /// </summary>
+        let alpha = 0.85f
+
+    module Common =
+        let defaultWorkGroupSize = 32

src/GraphBLAS-sharp.Backend/GraphBLAS-sharp.Backend.fsproj

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
@@ -11,14 +11,14 @@
 
   <ItemGroup>
     <Compile Include="AssemblyInfo.fs" />
+    <Compile Include="Constants/Constants.fs" />
     <Compile Include="Objects/Common.fs" />
     <Compile Include="Objects/ArraysExtentions.fs" />
     <Compile Include="Objects/Vector.fs" />
     <Compile Include="Objects/Matrix.fs" />
     <Compile Include="Objects/AtLeastOne.fs" />
     <Compile Include="Objects/ClContextExtensions.fs" />
     <Compile Include="Objects/ClCellExtensions.fs" />
-      
     <Compile Include="Quotes/SubReduce.fs" />
     <Compile Include="Quotes/Arithmetic.fs" />
     <Compile Include="Quotes/Convert.fs" />
@@ -28,7 +28,6 @@
     <Compile Include="Quotes/Predicates.fs" />
     <Compile Include="Quotes/Map.fs" />
     <Compile Include="Quotes/Search.fs" />
-
     <Compile Include="Common/Scatter.fs" />
     <Compile Include="Common/Utils.fs" />
     <Compile Include="Common/PrefixSum.fs" />
@@ -39,9 +38,7 @@
     <Compile Include="Common/ClArray.fs" />
     <Compile Include="Common/Sort/Radix.fs" />
     <Compile Include="Common/Sort/Bitonic.fs" />
-      
     <Compile Include="Common/Common.fs" />
-
     <Compile Include="Vector/Dense/Vector.fs" />
     <Compile Include="Vector/Sparse/Common.fs" />
     <Compile Include="Vector/Sparse/Merge.fs" />
@@ -61,19 +58,18 @@
     <Compile Include="Matrix/CSR/Matrix.fs" />
     <Compile Include="Matrix/LIL/Matrix.fs" />
     <Compile Include="Matrix/Matrix.fs" />
-    <Compile Include="Operations/SpGeMM/Expand.fs" />  
+    <Compile Include="Operations/SpGeMM/Expand.fs" />
     <Compile Include="Operations/SpGeMM/Masked.fs" />
     <Compile Include="Operations/SpMV.fs" />
-    <Compile Include="Operations/SpMSpV.fs" />  
+    <Compile Include="Operations/SpMSpV.fs" />
     <Compile Include="Operations/Kronecker.fs" />
     <Compile Include="Operations/Operations.fs" />
-
     <Compile Include="Algorithms/BFS.fs" />
     <Compile Include="Algorithms/MSBFS.fs" />
     <Compile Include="Algorithms/SSSP.fs" />
-    <Compile Include="Algorithms/PageRank.fs" />  
+    <Compile Include="Algorithms/PageRank.fsi" />
+    <Compile Include="Algorithms/PageRank.fs" />
     <Compile Include="Algorithms/Algorithms.fs" />
-      
   </ItemGroup>
   <Import Project="..\..\.paket\Paket.Restore.targets" />
 </Project>

src/GraphBLAS-sharp.Backend/Objects/Matrix.fs

@@ -181,36 +181,3 @@ type ClMatrix<'a when 'a: struct> =
         | ClMatrix.COO matrix -> matrix.NNZ
         | ClMatrix.CSC matrix -> matrix.NNZ
         | ClMatrix.LIL matrix -> matrix.NNZ
-
-/// <summary>
-/// Represents an abstraction over matrix, which is converted to correct format for PageRank algorithm
-/// </summary>
-type PageRankMatrix<'a when 'a: struct> =
-    | PageRankMatrix of ClMatrix<'a>
-    /// <summary>
-    /// Gets the number of rows in matrix.
-    /// </summary>
-    member this.RowCount =
-        match this with
-        | PageRankMatrix matrix -> matrix.RowCount
-
-    /// <summary>
-    /// Gets the number of columns in matrix.
-    /// </summary>
-    member this.ColumnCount =
-        match this with
-        | PageRankMatrix matrix -> matrix.ColumnCount
-
-    /// <summary>
-    /// Release device resources allocated for the matrix.
-    /// </summary>
-    member this.Dispose q =
-        match this with
-        | PageRankMatrix matrix -> matrix.Dispose q
-
-    /// <summary>
-    /// Gets the number of non-zero elements in matrix.
-    /// </summary>
-    member this.NNZ =
-        match this with
-        | PageRankMatrix matrix -> matrix.NNZ

tests/GraphBLAS-sharp.Tests/Backend/Algorithms/BFS.fs

@@ -14,7 +14,7 @@ let testFixtures (testContext: TestContext) =
     [ let config = Utils.undirectedAlgoConfig
       let context = testContext.ClContext
       let queue = testContext.Queue
-      let workGroupSize = Utils.defaultWorkGroupSize
+      let workGroupSize = Constants.Common.defaultWorkGroupSize
 
       let testName =
           sprintf "Test on %A" testContext.ClContext

tests/GraphBLAS-sharp.Tests/Backend/Algorithms/MSBFS.fs

@@ -12,7 +12,7 @@ open GraphBLAS.FSharp.Objects.MatrixExtensions
 
 let config = Utils.undirectedAlgoConfig
 
-let workGroupSize = Utils.defaultWorkGroupSize
+let workGroupSize = Constants.Common.defaultWorkGroupSize
 
 let makeLevelsTest context queue bfs (matrix: int [,]) =
     let graph = undirectedFromArray2D matrix 0