refactor: matrix, vector comments

YaccConstructor · Sep 29, 2023 · eb82c53 · eb82c53
1 parent bb708d0
commit eb82c53
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/src/GraphBLAS-sharp.Backend/Objects/Matrix.fs b/src/GraphBLAS-sharp.Backend/Objects/Matrix.fs
@@ -118,9 +118,21 @@ module ClMatrix =
 /// </summary>
 [<RequireQualifiedAccess>]
 type ClMatrix<'a when 'a: struct> =
+    /// <summary>
+    /// Represents an abstraction over matrix in CSR format, whose values and indices are in OpenCL device memory.
+    /// </summary>
     | CSR of ClMatrix.CSR<'a>
+    /// <summary>
+    /// Represents an abstraction over matrix in COO format, whose values and indices are in OpenCL device memory.
+    /// </summary>
     | COO of ClMatrix.COO<'a>
+    /// <summary>
+    /// Represents an abstraction over matrix in CSC format, whose values and indices are in OpenCL device memory.
+    /// </summary>
     | CSC of ClMatrix.CSC<'a>
+    /// <summary>
+    /// Represents an abstraction over matrix in LIL format, whose values and indices are in OpenCL device memory.
+    /// </summary>
     | LIL of ClMatrix.LIL<'a>
 
     /// <summary>

diff --git a/src/GraphBLAS-sharp.Backend/Objects/Vector.fs b/src/GraphBLAS-sharp.Backend/Objects/Vector.fs
@@ -29,7 +29,13 @@ module ClVector =
 /// </summary>
 [<RequireQualifiedAccess>]
 type ClVector<'a when 'a: struct> =
+    /// <summary>
+    /// Represents an abstraction over sparse vector, whose values and indices are in OpenCL device memory.
+    /// </summary>
     | Sparse of ClVector.Sparse<'a>
+    /// <summary>
+    /// Represents an abstraction over dense vector, whose values and indices are in OpenCL device memory.
+    /// </summary>
     | Dense of ClArray<'a option>
 
     /// <summary>