Fix warnings about missing XML comments in SparseQR base class.

wo80 · Apr 3, 2024 · 8c2c61d · 8c2c61d
1 parent 81cdafc
commit 8c2c61d
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 8 deletions.
diff --git a/CSparse/Factorization/SparseQR.cs b/CSparse/Factorization/SparseQR.cs
@@ -10,23 +10,35 @@ namespace CSparse.Factorization
     public abstract class SparseQR<T> : ISparseFactorization<T>
         where T : struct, IEquatable<T>, IFormattable
     {
-        protected readonly int m, n;
+        /// <summary>number of rows</summary>
+        protected readonly int m;
 
+        /// <summary>number of columns</summary>
+        protected readonly int n;
+
+        /// <summary>symbolic factorization</summary>
         protected SymbolicFactorization S;
-        protected CompressedColumnStorage<T> Q, R;
+
+        /// <summary>Q factor</summary>
+        protected CompressedColumnStorage<T> Q;
+
+        /// <summary>R factor</summary>
+        protected CompressedColumnStorage<T> R;
+
+        /// <summary>factors for Householder reflection</summary>
         protected double[] beta;
 
         /// <summary>
         /// Initializes a new instance of the SparseQR class.
         /// </summary>
         protected SparseQR(int rows, int columns)
         {
-            this.m = rows;
-            this.n = columns;
+            m = rows;
+            n = columns;
         }
 
         /// <summary>
-        /// Gets the number of nonzeros in both Q and R factors together.
+        /// Gets the number of non-zeros in both Q and R factors together.
         /// </summary>
         public int NonZerosCount
         {

diff --git a/CSparse/Factorization/SymbolicFactorization.cs b/CSparse/Factorization/SymbolicFactorization.cs
@@ -31,17 +31,17 @@ public class SymbolicFactorization
         public int[] leftmost;
 
         /// <summary>
-        /// # of rows for QR, after adding fictitious rows
+        /// number of rows for QR, after adding fictitious rows
         /// </summary>
         public int m2;
 
         /// <summary>
-        /// # entries in L for LU or Cholesky; in V for QR
+        /// number of entries in L for LU or Cholesky; in V for QR
         /// </summary>
         public int lnz;
 
         /// <summary>
-        /// # entries in U for LU; in R for QR
+        /// number of entries in U for LU; in R for QR
         /// </summary>
         public int unz;
     }