nalgebra_block_triangularization 0.1.0

Structural decomposition of sparse matrices into block triangular form using graph algorithms
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326

use nalgebra::{DMatrix, Dyn, PermutationSequence, Scalar};
use nalgebra_block_triangularization::{
    lower_block_triangular_structure, lower_triangular_permutations,
};

fn apply_perms<T: Scalar + Copy>(
    mut m: DMatrix<T>,
    pr: &PermutationSequence<Dyn>,
    pc: &PermutationSequence<Dyn>,
) -> DMatrix<T> {
    pr.permute_rows(&mut m);
    pc.permute_columns(&mut m);
    m
}

fn is_lower_block_triangular_u8(m: &DMatrix<u8>, block_sizes: &[usize]) -> bool {
    let n = m.nrows();
    if n != m.ncols() {
        return false;
    }
    if block_sizes.iter().sum::<usize>() != n {
        return false;
    }

    let mut row_block = vec![0usize; n];
    let mut col_block = vec![0usize; n];

    let mut idx = 0usize;
    for (b, &sz) in block_sizes.iter().enumerate() {
        for _ in 0..sz {
            row_block[idx] = b;
            col_block[idx] = b;
            idx += 1;
        }
    }

    // For lower block triangular: nonzero at (i,j) requires row_block[i] >= col_block[j]
    for i in 0..n {
        for j in 0..n {
            if m[(i, j)] != 0 && row_block[i] < col_block[j] {
                return false;
            }
        }
    }
    true
}

#[test]
fn example_matrix_produces_lower_block_triangular_form() {
    let data: [[u8; 8]; 8] = [
        [1, 0, 1, 0, 0, 0, 0, 0],
        [1, 0, 1, 0, 0, 0, 0, 0],
        [1, 1, 0, 1, 1, 0, 0, 0],
        [1, 1, 0, 1, 1, 0, 0, 0],
        [1, 1, 0, 0, 0, 0, 0, 0],
        [1, 1, 1, 0, 0, 1, 1, 0],
        [1, 1, 1, 0, 0, 1, 1, 0],
        [1, 1, 0, 0, 0, 0, 1, 1],
    ];

    let m = DMatrix::from_fn(8, 8, |i, j| data[i][j]);
    let structure = lower_block_triangular_structure(&m);
    let (pr, pc) = lower_triangular_permutations(&m);
    let l = apply_perms(m.clone(), &pr, &pc);

    assert_eq!(structure.matching_size, 8);
    assert!(is_lower_block_triangular_u8(&l, &structure.block_sizes));
}

#[test]
fn empty_matrix() {
    let m: DMatrix<u8> = DMatrix::zeros(0, 0);
    let structure = lower_block_triangular_structure(&m);
    let (pr, pc) = lower_triangular_permutations(&m);

    assert_eq!(structure.matching_size, 0);
    assert_eq!(structure.block_sizes.len(), 0);
    assert_eq!(structure.row_order.len(), 0);
    assert_eq!(structure.col_order.len(), 0);

    let l = apply_perms(m.clone(), &pr, &pc);
    assert_eq!(l.nrows(), 0);
    assert_eq!(l.ncols(), 0);
}

#[test]
fn single_element_nonzero() {
    let m = DMatrix::from_element(1, 1, 1u8);
    let structure = lower_block_triangular_structure(&m);
    let (pr, pc) = lower_triangular_permutations(&m);

    assert_eq!(structure.matching_size, 1);
    assert_eq!(structure.block_sizes, vec![1]);
    assert_eq!(structure.row_order, vec![0]);
    assert_eq!(structure.col_order, vec![0]);

    let l = apply_perms(m.clone(), &pr, &pc);
    assert_eq!(l[(0, 0)], 1);
}

#[test]
fn single_element_zero() {
    let m = DMatrix::from_element(1, 1, 0u8);
    let structure = lower_block_triangular_structure(&m);

    assert_eq!(structure.matching_size, 0);
    assert_eq!(structure.row_order, vec![0]);
    assert_eq!(structure.col_order, vec![0]);
}

#[test]
fn identity_matrix() {
    let m: DMatrix<f64> = DMatrix::identity(5, 5);
    let structure = lower_block_triangular_structure(&m);
    let (pr, pc) = lower_triangular_permutations(&m);

    assert_eq!(structure.matching_size, 5);
    assert_eq!(structure.block_sizes.len(), 5);
    assert_eq!(structure.block_sizes.iter().sum::<usize>(), 5);

    let l = apply_perms(m.clone(), &pr, &pc);
    assert!(is_lower_block_triangular_u8(
        &l.map(|x| if x != 0.0 { 1 } else { 0 }),
        &structure.block_sizes
    ));
}

#[test]
fn all_zeros_matrix() {
    let m: DMatrix<u8> = DMatrix::zeros(4, 4);
    let structure = lower_block_triangular_structure(&m);

    assert_eq!(structure.matching_size, 0);
    assert_eq!(structure.row_order.len(), 4);
    assert_eq!(structure.col_order.len(), 4);
}

#[test]
fn all_ones_matrix() {
    let m = DMatrix::from_element(4, 4, 1u8);
    let structure = lower_block_triangular_structure(&m);
    let (pr, pc) = lower_triangular_permutations(&m);

    assert_eq!(structure.matching_size, 4);
    assert_eq!(structure.block_sizes.len(), 1);
    assert_eq!(structure.block_sizes[0], 4);

    let l = apply_perms(m.clone(), &pr, &pc);
    assert!(is_lower_block_triangular_u8(&l, &structure.block_sizes));
}

#[test]
fn rectangular_more_rows() {
    let m = DMatrix::from_row_slice(5, 3, &[1, 0, 0, 0, 1, 0, 0, 0, 1, 1, 0, 0, 0, 1, 0]);
    let structure = lower_block_triangular_structure(&m);

    assert_eq!(structure.matching_size, 3);
    assert_eq!(structure.row_order.len(), 5);
    assert_eq!(structure.col_order.len(), 3);
}

#[test]
fn rectangular_more_cols() {
    let m = DMatrix::from_row_slice(3, 5, &[1, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 0]);
    let structure = lower_block_triangular_structure(&m);

    assert_eq!(structure.matching_size, 3);
    assert_eq!(structure.row_order.len(), 3);
    assert_eq!(structure.col_order.len(), 5);

    let unmatched_cols = structure.col_order[3..].to_vec();
    assert_eq!(unmatched_cols.len(), 2);
}

#[test]
fn triangular_already_lower() {
    let m = DMatrix::from_row_slice(4, 4, &[1, 0, 0, 0, 1, 1, 0, 0, 1, 1, 1, 0, 1, 1, 1, 1]);
    let structure = lower_block_triangular_structure(&m);
    let (pr, pc) = lower_triangular_permutations(&m);

    assert_eq!(structure.matching_size, 4);

    let l = apply_perms(m.clone(), &pr, &pc);
    assert!(is_lower_block_triangular_u8(&l, &structure.block_sizes));
}

#[test]
fn triangular_upper() {
    let m = DMatrix::from_row_slice(4, 4, &[1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 0, 0, 0, 1]);
    let structure = lower_block_triangular_structure(&m);
    let (pr, pc) = lower_triangular_permutations(&m);

    assert_eq!(structure.matching_size, 4);

    let l = apply_perms(m.clone(), &pr, &pc);
    assert!(is_lower_block_triangular_u8(&l, &structure.block_sizes));
}

#[test]
fn block_diagonal() {
    let m = DMatrix::from_row_slice(4, 4, &[1, 1, 0, 0, 1, 1, 0, 0, 0, 0, 1, 1, 0, 0, 1, 1]);
    let structure = lower_block_triangular_structure(&m);
    let (pr, pc) = lower_triangular_permutations(&m);

    assert_eq!(structure.matching_size, 4);
    assert_eq!(structure.block_sizes.len(), 2);

    let l = apply_perms(m.clone(), &pr, &pc);
    assert!(is_lower_block_triangular_u8(&l, &structure.block_sizes));
}

#[test]
fn structurally_singular() {
    let m = DMatrix::from_row_slice(
        4,
        4,
        &[
            1, 0, 0, 0, 1, 0, 0, 0, // Same as row 0
            0, 1, 0, 0, 0, 0, 1, 0,
        ],
    );
    let structure = lower_block_triangular_structure(&m);

    assert_eq!(structure.matching_size, 3);
}

#[test]
fn cyclic_dependency() {
    let m = DMatrix::from_row_slice(
        3,
        3,
        &[
            0, 1, 1, // Row 0 touches cols 1, 2
            1, 0, 1, // Row 1 touches cols 0, 2
            1, 1, 0, // Row 2 touches cols 0, 1
        ],
    );
    let structure = lower_block_triangular_structure(&m);
    let (pr, pc) = lower_triangular_permutations(&m);

    assert_eq!(structure.matching_size, 3);
    assert_eq!(structure.block_sizes.len(), 1);
    assert_eq!(structure.block_sizes[0], 3);

    let l = apply_perms(m.clone(), &pr, &pc);
    assert!(is_lower_block_triangular_u8(&l, &structure.block_sizes));
}

#[test]
fn sparse_pattern() {
    let m = DMatrix::from_row_slice(
        6,
        6,
        &[
            1, 1, 0, 0, 0, 0, 1, 1, 0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 0, 1, 1, 1, 0, 0, 0, 0, 1, 0, 1,
            1, 0, 0, 0, 1, 1, 1,
        ],
    );
    let structure = lower_block_triangular_structure(&m);
    let (pr, pc) = lower_triangular_permutations(&m);

    assert_eq!(structure.matching_size, 6);

    let l = apply_perms(m.clone(), &pr, &pc);
    assert!(is_lower_block_triangular_u8(&l, &structure.block_sizes));
}

#[test]
fn different_scalar_types() {
    let m_f64 = DMatrix::from_row_slice(3, 3, &[1.0, 2.0, 0.0, 3.0, 4.0, 0.0, 0.0, 5.0, 6.0]);
    let structure = lower_block_triangular_structure(&m_f64);
    assert_eq!(structure.matching_size, 3);

    let m_i32 = DMatrix::from_row_slice(3, 3, &[1, 2, 0, 3, 4, 0, 0, 5, 6]);
    let structure = lower_block_triangular_structure(&m_i32);
    assert_eq!(structure.matching_size, 3);
}

#[test]
fn permutations_are_invertible() {
    let m = DMatrix::from_row_slice(4, 4, &[0, 1, 1, 0, 1, 0, 1, 0, 1, 1, 0, 1, 0, 0, 1, 0]);

    let structure = lower_block_triangular_structure(&m);
    let (pr, pc) = lower_triangular_permutations(&m);

    let l = apply_perms(m.clone(), &pr, &pc);

    assert!(is_lower_block_triangular_u8(&l, &structure.block_sizes));

    assert_eq!(structure.row_order.len(), 4);
    assert_eq!(structure.col_order.len(), 4);
}

#[test]
fn block_indices_method() {
    let m = DMatrix::from_row_slice(
        6,
        6,
        &[
            1, 1, 0, 0, 0, 0, 1, 1, 0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 0, 1, 1, 1, 0, 0, 0, 0, 1, 0, 1,
            1, 0, 0, 0, 1, 1, 1,
        ],
    );
    let structure = lower_block_triangular_structure(&m);
    let blocks = structure.block_indices();

    // Verify number of blocks matches
    assert_eq!(blocks.len(), structure.block_sizes.len());

    // Verify each block has correct size
    for (i, (row_block, col_block)) in blocks.iter().enumerate() {
        assert_eq!(row_block.len(), structure.block_sizes[i]);
        assert_eq!(col_block.len(), structure.block_sizes[i]);
    }

    // Verify all rows are covered exactly once
    let all_rows: Vec<usize> = blocks
        .iter()
        .flat_map(|(rows, _)| rows.iter().copied())
        .collect();
    let mut sorted_rows = all_rows.clone();
    sorted_rows.sort_unstable();
    sorted_rows.dedup();
    assert_eq!(sorted_rows.len(), 6);
    assert_eq!(sorted_rows, vec![0, 1, 2, 3, 4, 5]);
}