refactor: objects comments

Author: artemiipatov

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

@@ -113,34 +113,49 @@ module ClMatrix =
 
         member this.NNZ = this.Values.Length
 
+/// <summary>
+/// Represents an abstraction over matrix, whose values and indices are in OpenCL device memory.
+/// </summary>
 [<RequireQualifiedAccess>]
 type ClMatrix<'a when 'a: struct> =
     | CSR of ClMatrix.CSR<'a>
     | COO of ClMatrix.COO<'a>
     | CSC of ClMatrix.CSC<'a>
     | LIL of ClMatrix.LIL<'a>
 
+    /// <summary>
+    /// Row count.
+    /// </summary>
     member this.RowCount =
         match this with
         | ClMatrix.CSR matrix -> matrix.RowCount
         | ClMatrix.COO matrix -> matrix.RowCount
         | ClMatrix.CSC matrix -> matrix.RowCount
         | ClMatrix.LIL matrix -> matrix.RowCount
 
+    /// <summary>
+    /// Column count.
+    /// </summary>
     member this.ColumnCount =
         match this with
         | ClMatrix.CSR matrix -> matrix.ColumnCount
         | ClMatrix.COO matrix -> matrix.ColumnCount
         | ClMatrix.CSC matrix -> matrix.ColumnCount
         | ClMatrix.LIL matrix -> matrix.ColumnCount
 
+    /// <summary>
+    /// Release resources allocated for the matrix.
+    /// </summary>
     member this.Dispose q =
         match this with
         | ClMatrix.CSR matrix -> (matrix :> IDeviceMemObject).Dispose q
         | ClMatrix.COO matrix -> (matrix :> IDeviceMemObject).Dispose q
         | ClMatrix.CSC matrix -> (matrix :> IDeviceMemObject).Dispose q
         | ClMatrix.LIL matrix -> (matrix :> IDeviceMemObject).Dispose q
 
+    /// <summary>
+    /// Number of non-zero elements in matrix.
+    /// </summary>
     member this.NNZ =
         match this with
         | ClMatrix.CSR matrix -> matrix.NNZ

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

@@ -24,15 +24,25 @@ module ClVector =
 
         member this.NNZ = this.Values.Length
 
+/// <summary>
+/// Represents an abstraction over vector, whose values and indices are in OpenCL device memory.
+/// </summary>
 [<RequireQualifiedAccess>]
 type ClVector<'a when 'a: struct> =
     | Sparse of ClVector.Sparse<'a>
     | Dense of ClArray<'a option>
+
+    /// <summary>
+    /// Gets the number of elements in vector.
+    /// </summary>
     member this.Size =
         match this with
         | Sparse vector -> vector.Size
         | Dense vector -> vector.Size
 
+    /// <summary>
+    /// Release resources allocated for the matrix.
+    /// </summary>
     member this.Dispose(q) =
         match this with
         | Sparse vector -> vector.Dispose(q)