Skip to content

Commit 8c2c61d

Browse files
committed
Fix warnings about missing XML comments in SparseQR base class.
1 parent 81cdafc commit 8c2c61d

File tree

2 files changed

+20
-8
lines changed

2 files changed

+20
-8
lines changed

CSparse/Factorization/SparseQR.cs

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,35 @@ namespace CSparse.Factorization
1010
public abstract class SparseQR<T> : ISparseFactorization<T>
1111
where T : struct, IEquatable<T>, IFormattable
1212
{
13-
protected readonly int m, n;
13+
/// <summary>number of rows</summary>
14+
protected readonly int m;
1415

16+
/// <summary>number of columns</summary>
17+
protected readonly int n;
18+
19+
/// <summary>symbolic factorization</summary>
1520
protected SymbolicFactorization S;
16-
protected CompressedColumnStorage<T> Q, R;
21+
22+
/// <summary>Q factor</summary>
23+
protected CompressedColumnStorage<T> Q;
24+
25+
/// <summary>R factor</summary>
26+
protected CompressedColumnStorage<T> R;
27+
28+
/// <summary>factors for Householder reflection</summary>
1729
protected double[] beta;
1830

1931
/// <summary>
2032
/// Initializes a new instance of the SparseQR class.
2133
/// </summary>
2234
protected SparseQR(int rows, int columns)
2335
{
24-
this.m = rows;
25-
this.n = columns;
36+
m = rows;
37+
n = columns;
2638
}
2739

2840
/// <summary>
29-
/// Gets the number of nonzeros in both Q and R factors together.
41+
/// Gets the number of non-zeros in both Q and R factors together.
3042
/// </summary>
3143
public int NonZerosCount
3244
{

CSparse/Factorization/SymbolicFactorization.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,17 @@ public class SymbolicFactorization
3131
public int[] leftmost;
3232

3333
/// <summary>
34-
/// # of rows for QR, after adding fictitious rows
34+
/// number of rows for QR, after adding fictitious rows
3535
/// </summary>
3636
public int m2;
3737

3838
/// <summary>
39-
/// # entries in L for LU or Cholesky; in V for QR
39+
/// number of entries in L for LU or Cholesky; in V for QR
4040
/// </summary>
4141
public int lnz;
4242

4343
/// <summary>
44-
/// # entries in U for LU; in R for QR
44+
/// number of entries in U for LU; in R for QR
4545
/// </summary>
4646
public int unz;
4747
}

0 commit comments

Comments
 (0)