Skip to content

Commit 9f7ac1d

Browse files
wo80wo80
authored
Merge pull request #52 from wo80/dev
Make SymbolicColumnStorage class public
2 parents d096317 + 7c301d4 commit 9f7ac1d

9 files changed

+313
-98
lines changed

‎CSparse.Tests/CSparse.Tests.csproj

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@
4141
</ItemGroup>
4242

4343
<ItemGroup>
44-
<PackageReference Include="NUnit" Version="4.1.0" />
45-
<PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
46-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
44+
<PackageReference Include="NUnit" Version="4.2.2" />
45+
<PackageReference Include="NUnit3TestAdapter" Version="4.6.0" />
46+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
4747
</ItemGroup>
4848

4949
<ItemGroup>

‎CSparse.Tests/Ordering/TestAMD.cs

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
using CSparse.Ordering;
2+
using CSparse.Storage;
3+
using NUnit.Framework;
4+
5+
namespace CSparse.Tests.Ordering
6+
{
7+
class TestAMD
8+
{
9+
[Test]
10+
public void TestAMD1()
11+
{
12+
int[] ap = [0, 9, 15, 21, 27, 33, 39, 48, 57, 61, 70, 76, 82, 88, 94, 100, 106, 110, 119, 128, 137, 143, 152, 156, 160];
13+
int[] ai = [
14+
/* col 0 */ 0, 5, 6, 12, 13, 17, 18, 19, 21,
15+
/* col 1 */ 1, 8, 9, 13, 14, 17,
16+
/* col 2 */ 2, 6, 11, 20, 21, 22,
17+
/* col 3 */ 3, 7, 10, 15, 18, 19,
18+
/* col 4 */ 4, 7, 9, 14, 15, 16,
19+
/* col 5 */ 0, 5, 6, 12, 13, 17,
20+
/* col 6 */ 0, 2, 5, 6, 11, 12, 19, 21, 23,
21+
/* col 7 */ 3, 4, 7, 9, 14, 15, 16, 17, 18,
22+
/* col 8 */ 1, 8, 9, 14,
23+
/* col 9 */ 1, 4, 7, 8, 9, 13, 14, 17, 18,
24+
/* col 10 */ 3, 10, 18, 19, 20, 21,
25+
/* col 11 */ 2, 6, 11, 12, 21, 23,
26+
/* col 12 */ 0, 5, 6, 11, 12, 23,
27+
/* col 13 */ 0, 1, 5, 9, 13, 17,
28+
/* col 14 */ 1, 4, 7, 8, 9, 14,
29+
/* col 15 */ 3, 4, 7, 15, 16, 18,
30+
/* col 16 */ 4, 7, 15, 16,
31+
/* col 17 */ 0, 1, 5, 7, 9, 13, 17, 18, 19,
32+
/* col 18 */ 0, 3, 7, 9, 10, 15, 17, 18, 19,
33+
/* col 19 */ 0, 3, 6, 10, 17, 18, 19, 20, 21,
34+
/* col 20 */ 2, 10, 19, 20, 21, 22,
35+
/* col 21 */ 0, 2, 6, 10, 11, 19, 20, 21, 22,
36+
/* col 22 */ 2, 20, 21, 22,
37+
/* col 23 */ 6, 11, 12, 23 ];
38+
39+
var S = new SymbolicColumnStorage(24, 24, ap, ai, false);
40+
41+
var p = AMD.Generate(S, ColumnOrdering.MinimumDegreeAtA);
42+
43+
int[] expected = [8, 16, 4, 14, 15, 1, 7, 9, 22, 23, 2, 11, 3, 12, 13, 17, 18, 0, 10, 19, 20, 6, 21, 5, 24];
44+
45+
Assert.That(Permutation.IsValid(p), Is.True);
46+
Assert.That(p, Is.EqualTo(expected).AsCollection);
47+
}
48+
49+
[Test]
50+
public void TestAMD2()
51+
{
52+
int[] ap = [0, 9, 14, 20, 28, 33, 37, 44, 53, 58, 63, 63, 66, 69, 72, 75, 78, 82, 86, 91, 97, 101, 112, 112, 116];
53+
int[] ai = [
54+
/* col 0 */ 0, 17, 18, 21, 5, 12, 5, 0, 13,
55+
/* col 1 */ 14, 1, 8, 13, 17,
56+
/* col 2 */ 2, 20, 11, 6, 11, 22,
57+
/* col 3 */ 3, 3, 10, 7, 18, 18, 15, 19,
58+
/* col 4 */ 7, 9, 15, 14, 16,
59+
/* col 5 */ 5, 13, 6, 17,
60+
/* col 6 */ 5, 0, 11, 6, 12, 6, 23,
61+
/* col 7 */ 3, 4, 9, 7, 14, 16, 15, 17, 18,
62+
/* col 8 */ 1, 9, 14, 14, 14,
63+
/* col 9 */ 7, 13, 8, 1, 17,
64+
/* col 10 */
65+
/* col 11 */ 2, 12, 23,
66+
/* col 12 */ 5, 11, 12,
67+
/* col 13 */ 0, 13, 17,
68+
/* col 14 */ 1, 9, 14,
69+
/* col 15 */ 3, 15, 16,
70+
/* col 16 */ 16, 4, 4, 15,
71+
/* col 17 */ 13, 17, 19, 17,
72+
/* col 18 */ 15, 17, 19, 9, 10,
73+
/* col 19 */ 17, 19, 20, 0, 6, 10,
74+
/* col 20 */ 22, 10, 20, 21,
75+
/* col 21 */ 6, 2, 10, 19, 20, 11, 21, 22, 22, 22, 22,
76+
/* col 22 */
77+
/* col 23 */ 12, 11, 12, 23 ];
78+
79+
var S = new SymbolicColumnStorage(24, 24, ap, ai, false);
80+
81+
var p = AMD.Generate(S, ColumnOrdering.MinimumDegreeAtA);
82+
83+
int[] expected = [10, 11, 23, 12, 2, 6, 8, 14, 15, 16, 4, 1, 9, 7, 18, 3, 5, 17, 0, 19, 20, 21, 13, 22, 24];
84+
85+
Assert.That(Permutation.IsValid(p), Is.True);
86+
Assert.That(p, Is.EqualTo(expected).AsCollection);
87+
}
88+
}
89+
}

‎CSparse.Tests/Ordering/TestDulmageMendelsohn.cs

+43
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
namespace CSparse.Tests.Ordering
22
{
3+
using CSparse.Double;
34
using CSparse.Ordering;
5+
using CSparse.Storage;
46
using NUnit.Framework;
57
using System;
68

@@ -33,5 +35,46 @@ public void TestGenerate2()
3335

3436
Assert.That(dm.StructuralRank == n, Is.True);
3537
}
38+
39+
[Test]
40+
public void TestGenerate3()
41+
{
42+
var A = SparseMatrix.OfRowMajor(8, 8,
43+
[
44+
11, 12, 0, 0, 0, 0, 0, 0,
45+
0, 22, 23, 0, 25, 26, 0, 0,
46+
0, 0, 33, 34, 0, 0, 37, 0,
47+
0, 0, 43, 44, 0, 0, 0, 48,
48+
51, 0, 0, 0, 55, 56, 0, 0,
49+
0, 0, 0, 0, 0, 66, 67, 0,
50+
0, 0, 0, 0, 0, 76, 77, 0,
51+
0, 0, 0, 84, 0, 0, 87, 88
52+
]);
53+
54+
var S = SymbolicColumnStorage.Create(A);
55+
56+
var dm = DulmageMendelsohn.Generate(S, 1);
57+
58+
Assert.That(dm.StructuralRank, Is.EqualTo(8));
59+
Assert.That(dm.Blocks, Is.EqualTo(3));
60+
61+
int[] expected = [0, 1, 4, 2, 3, 7, 5, 6];
62+
63+
Assert.That(dm.RowPermutation, Is.EqualTo(expected).AsCollection);
64+
Assert.That(dm.ColumnPermutation, Is.EqualTo(expected).AsCollection);
65+
66+
expected = [0, 3, 6, 8];
67+
68+
Assert.That(dm.BlockRowPointers, Is.EqualTo(expected).AsCollection);
69+
Assert.That(dm.BlockColumnPointers, Is.EqualTo(expected).AsCollection);
70+
71+
expected = [0, 0, 8, 8, 8];
72+
73+
Assert.That(dm.CoarseRowDecomposition, Is.EqualTo(expected).AsCollection);
74+
75+
expected = [0, 0, 0, 8, 8];
76+
77+
Assert.That(dm.CoarseColumnDecomposition, Is.EqualTo(expected).AsCollection);
78+
}
3679
}
3780
}

‎CSparse/CSparse.csproj

+7-3
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,21 @@
1111
<Company />
1212
<Copyright>Copyright Christian Woltering © 2012-2024</Copyright>
1313
<Authors>Christian Woltering</Authors>
14-
<AssemblyVersion>4.1.0.0</AssemblyVersion>
15-
<FileVersion>4.1.0.0</FileVersion>
14+
<AssemblyVersion>4.2.0.0</AssemblyVersion>
15+
<FileVersion>4.2.0.0</FileVersion>
1616
<PackageTags>math sparse matrix lu cholesky qr decomposition factorization </PackageTags>
17-
<Version>4.1.0</Version>
17+
<Version>4.2.0</Version>
1818
<AssemblyName>CSparse</AssemblyName>
1919
<RootNamespace>CSparse</RootNamespace>
2020
<PackageLicenseExpression>LGPL-2.1-only</PackageLicenseExpression>
2121
<PackageProjectUrl>https://github.com/wo80/CSparse.NET</PackageProjectUrl>
2222
<RepositoryUrl>https://github.com/wo80/CSparse.NET.git</RepositoryUrl>
2323
<RepositoryType>git</RepositoryType>
2424
<PackageReleaseNotes>
25+
Version 4.2.0
26+
27+
* Make SymbolicColumnStorage class public and update StronglyConnectedComponents and DulmageMendelsohn decomposition accordingly.
28+
2529
Version 4.1.0
2630

2731
* Add overload for creating a sparse matrix from an enumerable of ValueTuple.

‎CSparse/Ordering/AMD.cs

+22-6
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,22 @@ public static class AMD
2525
/// </remarks>
2626
public static int[] Generate<T>(CompressedColumnStorage<T> A, ColumnOrdering order)
2727
where T : struct, IEquatable<T>, IFormattable
28+
{
29+
return Generate(SymbolicColumnStorage.Create(A), order);
30+
}
31+
32+
/// <summary>
33+
/// Generate minimum degree ordering of A+A' (if A is symmetric) or A'A.
34+
/// </summary>
35+
/// <param name="A">Column-compressed matrix</param>
36+
/// <param name="order">Column ordering method</param>
37+
/// <returns>amd(A+A') if A is symmetric, or amd(A'A) otherwise, null on
38+
/// error or for natural ordering</returns>
39+
/// <remarks>
40+
/// See Chapter 7.1 (Fill-reducing orderings: Minimum degree ordering) in
41+
/// "Direct Methods for Sparse Linear Systems" by Tim Davis.
42+
/// </remarks>
43+
public static int[] Generate(SymbolicColumnStorage A, ColumnOrdering order)
2844
{
2945
int[] Cp, Ci, P, W, nv, next, head, elen, degree, w, hhead;
3046

@@ -42,7 +58,7 @@ public static int[] Generate<T>(CompressedColumnStorage<T> A, ColumnOrdering ord
4258
return Permutation.Create(n);
4359
}
4460

45-
var C = ConstructMatrix(SymbolicColumnStorage.Create(A), order);
61+
var C = ConstructMatrix(A, order);
4662

4763
Cp = C.ColumnPointers;
4864
cnz = Cp[n];
@@ -139,7 +155,7 @@ public static int[] Generate<T>(CompressedColumnStorage<T> A, ColumnOrdering ord
139155
Ci[p] = -(j + 2); // first entry is now CS_FLIP(j)
140156
}
141157
}
142-
for (q = 0, p = 0; p < cnz; ) // scan all of memory
158+
for (q = 0, p = 0; p < cnz;) // scan all of memory
143159
{
144160
if ((j = FLIP(Ci[p++])) >= 0) // found object j
145161
{
@@ -303,7 +319,7 @@ public static int[] Generate<T>(CompressedColumnStorage<T> A, ColumnOrdering ord
303319
eln = elen[i];
304320
for (p = Cp[i] + 1; p <= Cp[i] + ln - 1; p++) w[Ci[p]] = mark;
305321
jlast = i;
306-
for (j = next[i]; j != -1; ) // compare i with all j
322+
for (j = next[i]; j != -1;) // compare i with all j
307323
{
308324
ok = (W[j] == ln) && (elen[j] == eln);
309325
for (p = Cp[j] + 1; ok && p <= Cp[j] + ln - 1; p++)
@@ -411,13 +427,13 @@ private static bool KeepOffDiag(int i, int j)
411427
private static SymbolicColumnStorage ConstructMatrix(SymbolicColumnStorage A, ColumnOrdering order)
412428
{
413429
SymbolicColumnStorage result = null;
414-
430+
415431
// Compute A'
416432
var AT = A.Transpose();
417433

418434
int m = A.RowCount;
419435
int n = A.ColumnCount;
420-
436+
421437
if (order == ColumnOrdering.MinimumDegreeAtPlusA)
422438
{
423439
if (n != m)
@@ -444,7 +460,7 @@ private static SymbolicColumnStorage ConstructMatrix(SymbolicColumnStorage A, Co
444460
{
445461
// Column j of AT starts here.
446462
p = colptr[j];
447-
463+
448464
// New column j starts here.
449465
colptr[j] = p2;
450466

‎CSparse/Ordering/DulmageMendelsohn.cs

+15-8
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public sealed class DulmageMendelsohn
2222
private int nb; // number of blocks in fine dmperm decomposition
2323

2424
/// <summary>
25-
/// Create a new Decomposition instance.
25+
/// Create a new decomposition instance.
2626
/// </summary>
2727
private DulmageMendelsohn(int m, int n)
2828
{
@@ -97,22 +97,29 @@ public int Singletons
9797
public int[] CoarseColumnDecomposition => cc;
9898

9999
/// <summary>
100-
/// Compute coarse and then fine Dulmage-Mendelsohn decomposition. seed
101-
/// optionally selects a randomized algorithm.
100+
/// Compute coarse and fine Dulmage-Mendelsohn decomposition.
102101
/// </summary>
103102
/// <param name="matrix">column-compressed matrix</param>
104-
/// <param name="seed">0: natural, -1: reverse, random order otherwise</param>
103+
/// <param name="seed"> The seed optionally selects a randomized algorithm (0 = default (natural), -1 = reverse, random order otherwise).</param>
105104
/// <returns>Dulmage-Mendelsohn analysis</returns>
106105
public static DulmageMendelsohn Generate<T>(CompressedColumnStorage<T> matrix, int seed = 0)
107106
where T : struct, IEquatable<T>, IFormattable
107+
{
108+
return Generate(SymbolicColumnStorage.Create(matrix), seed);
109+
}
110+
111+
/// <summary>
112+
/// Compute coarse and fine Dulmage-Mendelsohn decomposition.
113+
/// </summary>
114+
/// <param name="A">The matrix represented by <see cref="SymbolicColumnStorage"/>.</param>
115+
/// <param name="seed"> The seed optionally selects a randomized algorithm (0 = default (natural), -1 = reverse, random order otherwise).</param>
116+
/// <returns>Dulmage-Mendelsohn analysis</returns>
117+
public static DulmageMendelsohn Generate(SymbolicColumnStorage A, int seed = 0)
108118
{
109119
int i, j, k, cnz, nc, nb1, nb2;
110120
int[] Cp, ps, rs;
111121
bool ok;
112122

113-
// We are not interested in the actual matrix values.
114-
var A = SymbolicColumnStorage.Create(matrix);
115-
116123
// Maximum matching
117124
int m = A.RowCount;
118125
int n = A.ColumnCount;
@@ -147,7 +154,7 @@ public static DulmageMendelsohn Generate<T>(CompressedColumnStorage<T> matrix, i
147154
// Fine decomposition
148155
int[] pinv = Permutation.Invert(p); // pinv=p'
149156

150-
var C = SymbolicColumnStorage.Create(matrix);
157+
var C = A.Clone();
151158
A.Permute(pinv, q, C); // C=A(p,q) (it will hold A(R2,C2))
152159

153160
Cp = C.ColumnPointers;

‎CSparse/Ordering/StronglyConnectedComponents.cs

+19-7
Original file line numberDiff line numberDiff line change
@@ -48,19 +48,31 @@ private StronglyConnectedComponents(int m, int n)
4848
public static StronglyConnectedComponents Generate<T>(CompressedColumnStorage<T> matrix)
4949
where T : struct, IEquatable<T>, IFormattable
5050
{
51-
return Generate(SymbolicColumnStorage.Create(matrix, false), matrix.ColumnCount);
51+
return Generate(SymbolicColumnStorage.Create(matrix, false));
5252
}
53-
53+
5454
/// <summary>
55-
/// Find strongly connected components of A.
55+
/// Compute strongly connected components of A.
5656
/// </summary>
57-
/// <param name="A"></param>
58-
/// <param name="n"></param>
59-
/// <returns></returns>
60-
internal static StronglyConnectedComponents Generate(SymbolicColumnStorage A, int n)
57+
/// <param name="A">The matrix represented by <see cref="SymbolicColumnStorage"/>.</param>
58+
/// <returns>Strongly connected components</returns>
59+
public static StronglyConnectedComponents Generate(SymbolicColumnStorage A)
60+
{
61+
return Generate(A, A.ColumnCount);
62+
}
63+
64+
/// <summary>
65+
/// Compute strongly connected components of A.
66+
/// </summary>
67+
/// <param name="A">The matrix represented by <see cref="SymbolicColumnStorage"/>.</param>
68+
/// <param name="size">The size of the matrix.</param>
69+
/// <returns>Strongly connected components</returns>
70+
public static StronglyConnectedComponents Generate(SymbolicColumnStorage A, int size)
6171
{
6272
// matrix A temporarily modified, then restored
6373

74+
int n = size;
75+
6476
int i, k, b, nb = 0, top;
6577
int[] xi, p, r, Ap, ATp;
6678

‎CSparse/Storage/CompressedColumnStorage.cs

+1-4
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,7 @@ public abstract class CompressedColumnStorage<T> : Matrix<T>
4040
/// <summary>
4141
/// Gets the number of non-zero entries.
4242
/// </summary>
43-
public int NonZerosCount
44-
{
45-
get { return ColumnPointers[columns]; }
46-
}
43+
public int NonZerosCount => ColumnPointers[columns];
4744

4845
/// <summary>
4946
/// Initializes a new instance of the <see cref="CompressedColumnStorage{T}"/> class.

0 commit comments

Comments
 (0)