Skip to content

Commit eb82c53

Browse files
committed
refactor: matrix, vector comments
1 parent bb708d0 commit eb82c53

2 files changed

Lines changed: 18 additions & 0 deletions

File tree

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,21 @@ module ClMatrix =
118118
/// </summary>
119119
[<RequireQualifiedAccess>]
120120
type ClMatrix<'a when 'a: struct> =
121+
/// <summary>
122+
/// Represents an abstraction over matrix in CSR format, whose values and indices are in OpenCL device memory.
123+
/// </summary>
121124
| CSR of ClMatrix.CSR<'a>
125+
/// <summary>
126+
/// Represents an abstraction over matrix in COO format, whose values and indices are in OpenCL device memory.
127+
/// </summary>
122128
| COO of ClMatrix.COO<'a>
129+
/// <summary>
130+
/// Represents an abstraction over matrix in CSC format, whose values and indices are in OpenCL device memory.
131+
/// </summary>
123132
| CSC of ClMatrix.CSC<'a>
133+
/// <summary>
134+
/// Represents an abstraction over matrix in LIL format, whose values and indices are in OpenCL device memory.
135+
/// </summary>
124136
| LIL of ClMatrix.LIL<'a>
125137

126138
/// <summary>

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,13 @@ module ClVector =
2929
/// </summary>
3030
[<RequireQualifiedAccess>]
3131
type ClVector<'a when 'a: struct> =
32+
/// <summary>
33+
/// Represents an abstraction over sparse vector, whose values and indices are in OpenCL device memory.
34+
/// </summary>
3235
| Sparse of ClVector.Sparse<'a>
36+
/// <summary>
37+
/// Represents an abstraction over dense vector, whose values and indices are in OpenCL device memory.
38+
/// </summary>
3339
| Dense of ClArray<'a option>
3440

3541
/// <summary>

0 commit comments

Comments
 (0)