aprender-core 0.29.1

Next-generation machine learning library in pure Rust
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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
pub(crate) use super::*;

// ==========================================================================
// FALSIFICATION: SparsityPattern validation
// ==========================================================================
#[test]
fn test_sparsity_pattern_nm_valid() {
    let pattern = SparsityPattern::NM { n: 2, m: 4 };
    assert!(
        pattern.is_valid(),
        "MSK-01 FALSIFIED: 2:4 pattern should be valid"
    );
}

#[test]
fn test_sparsity_pattern_nm_n_equals_m_valid() {
    // N=M is valid (no pruning)
    let pattern = SparsityPattern::NM { n: 4, m: 4 };
    assert!(
        pattern.is_valid(),
        "MSK-02 FALSIFIED: N=M pattern should be valid"
    );
}

#[test]
fn test_sparsity_pattern_nm_invalid_n_gt_m() {
    let pattern = SparsityPattern::NM { n: 5, m: 4 };
    assert!(
        !pattern.is_valid(),
        "MSK-03 FALSIFIED: N>M pattern should be invalid"
    );
}

#[test]
fn test_sparsity_pattern_nm_n_zero_valid() {
    // N=0 is valid (prune everything)
    let pattern = SparsityPattern::NM { n: 0, m: 4 };
    assert!(
        pattern.is_valid(),
        "MSK-04 FALSIFIED: N=0 pattern should be valid"
    );
}

#[test]
fn test_sparsity_pattern_block_valid() {
    let pattern = SparsityPattern::Block {
        height: 2,
        width: 2,
    };
    assert!(
        pattern.is_valid(),
        "MSK-05 FALSIFIED: block pattern should be valid"
    );
}

#[test]
fn test_sparsity_pattern_block_invalid_zero() {
    let pattern = SparsityPattern::Block {
        height: 0,
        width: 2,
    };
    assert!(
        !pattern.is_valid(),
        "MSK-06 FALSIFIED: zero height should be invalid"
    );
}

#[test]
fn test_sparsity_pattern_theoretical_sparsity() {
    let pattern = SparsityPattern::NM { n: 2, m: 4 };
    assert!(
        (pattern.theoretical_sparsity().unwrap() - 0.5).abs() < 1e-6,
        "MSK-07 FALSIFIED: 2:4 has 50% sparsity"
    );

    let pattern = SparsityPattern::NM { n: 1, m: 4 };
    assert!(
        (pattern.theoretical_sparsity().unwrap() - 0.75).abs() < 1e-6,
        "MSK-07 FALSIFIED: 1:4 has 75% sparsity"
    );
}

// ==========================================================================
// FALSIFICATION: SparsityMask creation validates binary values
// ==========================================================================
#[test]
fn test_sparsity_mask_accepts_binary() {
    let mask_data = Tensor::new(&[1.0, 0.0, 1.0, 0.0], &[4]);
    let mask = SparsityMask::new(mask_data, SparsityPattern::Unstructured);
    assert!(
        mask.is_ok(),
        "MSK-08 FALSIFIED: binary mask should be accepted"
    );
}

#[test]
fn test_sparsity_mask_rejects_non_binary() {
    let mask_data = Tensor::new(&[1.0, 0.5, 1.0, 0.0], &[4]);
    let mask = SparsityMask::new(mask_data, SparsityPattern::Unstructured);
    assert!(
        mask.is_err(),
        "MSK-09 FALSIFIED: non-binary mask should be rejected"
    );

    let err = mask.unwrap_err();
    match err {
        PruningError::InvalidMask { .. } => (),
        _ => panic!("MSK-09 FALSIFIED: Expected InvalidMask error"),
    }
}

#[test]
fn test_sparsity_mask_rejects_negative_values() {
    let mask_data = Tensor::new(&[1.0, -1.0, 1.0, 0.0], &[4]);
    let mask = SparsityMask::new(mask_data, SparsityPattern::Unstructured);
    assert!(
        mask.is_err(),
        "MSK-10 FALSIFIED: negative values should be rejected"
    );
}

// ==========================================================================
// FALSIFICATION: SparsityMask sparsity calculation
// ==========================================================================
#[test]
fn test_sparsity_mask_computes_sparsity_correctly() {
    // 2 zeros out of 4 = 50% sparsity
    let mask_data = Tensor::new(&[1.0, 0.0, 1.0, 0.0], &[4]);
    let mask = SparsityMask::new(mask_data, SparsityPattern::Unstructured).unwrap();
    assert!(
        (mask.sparsity() - 0.5).abs() < 1e-6,
        "MSK-11 FALSIFIED: sparsity should be 0.5"
    );
}

#[test]
fn test_sparsity_mask_all_ones_zero_sparsity() {
    let mask_data = Tensor::new(&[1.0, 1.0, 1.0, 1.0], &[4]);
    let mask = SparsityMask::new(mask_data, SparsityPattern::Unstructured).unwrap();
    assert!(
        (mask.sparsity() - 0.0).abs() < 1e-6,
        "MSK-12 FALSIFIED: all-ones mask has 0% sparsity"
    );
}

#[test]
fn test_sparsity_mask_all_zeros_full_sparsity() {
    let mask_data = Tensor::new(&[0.0, 0.0, 0.0, 0.0], &[4]);
    let mask = SparsityMask::new(mask_data, SparsityPattern::Unstructured).unwrap();
    assert!(
        (mask.sparsity() - 1.0).abs() < 1e-6,
        "MSK-13 FALSIFIED: all-zeros mask has 100% sparsity"
    );
}

// ==========================================================================
// FALSIFICATION: Mask application (Poka-Yoke shape validation)
// ==========================================================================
#[test]
fn test_mask_apply_correct_shape() {
    let mask_data = Tensor::new(&[1.0, 0.0, 1.0, 0.0], &[2, 2]);
    let mask = SparsityMask::new(mask_data, SparsityPattern::Unstructured).unwrap();

    let mut weights = Tensor::new(&[1.0, 2.0, 3.0, 4.0], &[2, 2]);
    let result = mask.apply(&mut weights);

    assert!(
        result.is_ok(),
        "MSK-14 FALSIFIED: should apply successfully"
    );
    assert_eq!(
        weights.data(),
        &[1.0, 0.0, 3.0, 0.0],
        "MSK-14 FALSIFIED: weights should be masked"
    );
}

#[test]
fn test_mask_apply_wrong_shape_fails() {
    let mask_data = Tensor::new(&[1.0, 0.0, 1.0, 0.0], &[4]);
    let mask = SparsityMask::new(mask_data, SparsityPattern::Unstructured).unwrap();

    let mut weights = Tensor::new(&[1.0, 2.0, 3.0], &[3]); // Wrong shape!
    let result = mask.apply(&mut weights);

    assert!(result.is_err(), "MSK-15 FALSIFIED: wrong shape should fail");
    match result.unwrap_err() {
        PruningError::ShapeMismatch { expected, got } => {
            assert_eq!(expected, vec![4]);
            assert_eq!(got, vec![3]);
        }
        _ => panic!("MSK-15 FALSIFIED: Expected ShapeMismatch error"),
    }
}

// ==========================================================================
// FALSIFICATION: Mask application is idempotent (spec item 48)
// ==========================================================================
#[test]
fn test_mask_apply_idempotent() {
    let mask_data = Tensor::new(&[1.0, 0.0, 1.0, 0.0], &[4]);
    let mask = SparsityMask::new(mask_data, SparsityPattern::Unstructured).unwrap();

    let mut weights1 = Tensor::new(&[1.0, 2.0, 3.0, 4.0], &[4]);
    let mut weights2 = Tensor::new(&[1.0, 2.0, 3.0, 4.0], &[4]);

    mask.apply(&mut weights1).unwrap();
    mask.apply(&mut weights1).unwrap(); // Apply twice
    mask.apply(&mut weights2).unwrap(); // Apply once

    assert_eq!(
        weights1.data(),
        weights2.data(),
        "MSK-16 FALSIFIED: mask application should be idempotent"
    );
}

// ==========================================================================
// FALSIFICATION: N:M mask validates structure
// ==========================================================================
#[test]
fn test_nm_mask_validates_structure() {
    // Create a valid 2:4 mask
    let mask_data = Tensor::new(
        &[
            1.0, 1.0, 0.0, 0.0, // Group 1: 2 ones
            0.0, 1.0, 1.0, 0.0, // Group 2: 2 ones
        ],
        &[8],
    );

    let pattern = SparsityPattern::NM { n: 2, m: 4 };
    let mask = SparsityMask::new(mask_data, pattern);
    assert!(
        mask.is_ok(),
        "MSK-17 FALSIFIED: valid 2:4 mask should be accepted"
    );
}

#[test]
fn test_nm_mask_rejects_invalid_structure() {
    // Invalid: 3 ones in first group (should be 2)
    let mask_data = Tensor::new(
        &[
            1.0, 1.0, 1.0, 0.0, // Group 1: 3 ones (INVALID!)
            0.0, 1.0, 1.0, 0.0, // Group 2: 2 ones
        ],
        &[8],
    );

    let pattern = SparsityPattern::NM { n: 2, m: 4 };
    let mask = SparsityMask::new(mask_data, pattern);
    assert!(
        mask.is_err(),
        "MSK-18 FALSIFIED: invalid N:M structure should be rejected"
    );
}

// ==========================================================================
// FALSIFICATION: generate_unstructured_mask
// ==========================================================================
#[test]
fn test_generate_unstructured_mask_basic() {
    let scores = Tensor::new(&[0.1, 0.4, 0.2, 0.3], &[4]);
    let mask = generate_unstructured_mask(&scores, 0.5).unwrap();

    // 50% sparsity = prune 2 lowest scores (0.1, 0.2)
    // Keep: 0.4, 0.3 -> mask = [0, 1, 0, 1]
    assert!(
        (mask.sparsity() - 0.5).abs() < 1e-6,
        "MSK-19 FALSIFIED: should achieve ~50% sparsity"
    );
}

#[test]
fn test_generate_unstructured_mask_zero_sparsity() {
    let scores = Tensor::new(&[0.1, 0.2, 0.3, 0.4], &[4]);
    let mask = generate_unstructured_mask(&scores, 0.0).unwrap();

    assert!(
        (mask.sparsity() - 0.0).abs() < 1e-6,
        "MSK-20 FALSIFIED: 0% sparsity should keep all"
    );
}

#[test]
fn test_generate_unstructured_mask_full_sparsity() {
    let scores = Tensor::new(&[0.1, 0.2, 0.3, 0.4], &[4]);
    let mask = generate_unstructured_mask(&scores, 1.0).unwrap();

    assert!(
        (mask.sparsity() - 1.0).abs() < 1e-6,
        "MSK-21 FALSIFIED: 100% sparsity should prune all"
    );
}

#[test]
fn test_generate_unstructured_mask_invalid_sparsity() {
    let scores = Tensor::new(&[0.1, 0.2], &[2]);

    assert!(
        generate_unstructured_mask(&scores, -0.1).is_err(),
        "MSK-22 FALSIFIED: negative sparsity should error"
    );
    assert!(
        generate_unstructured_mask(&scores, 1.1).is_err(),
        "MSK-22 FALSIFIED: sparsity >1 should error"
    );
}

// ==========================================================================
// FALSIFICATION: generate_nm_mask
// ==========================================================================
#[test]
fn test_generate_nm_mask_2_4() {
    let scores = Tensor::new(&[0.1, 0.4, 0.2, 0.3, 0.5, 0.1, 0.3, 0.2], &[8]);
    let mask = generate_nm_mask(&scores, 2, 4).unwrap();

    // Each group of 4 should have exactly 2 non-zeros
    let data = mask.tensor().data();
    for chunk in data.chunks(4) {
        let ones = chunk.iter().filter(|&&v| v > 0.5).count();
        assert_eq!(
            ones, 2,
            "MSK-23 FALSIFIED: each group should have 2 non-zeros"
        );
    }
}

#[test]
fn test_generate_nm_mask_keeps_top_n() {
    // Group 1: [0.1, 0.4, 0.2, 0.3] -> keep 0.4, 0.3
    let scores = Tensor::new(&[0.1, 0.4, 0.2, 0.3], &[4]);
    let mask = generate_nm_mask(&scores, 2, 4).unwrap();

    let data = mask.tensor().data();
    assert_eq!(data[0], 0.0, "MSK-24 FALSIFIED: 0.1 should be pruned");
    assert_eq!(data[1], 1.0, "MSK-24 FALSIFIED: 0.4 should be kept");
    assert_eq!(data[2], 0.0, "MSK-24 FALSIFIED: 0.2 should be pruned");
    assert_eq!(data[3], 1.0, "MSK-24 FALSIFIED: 0.3 should be kept");
}

#[test]
fn test_generate_nm_mask_invalid_n_gt_m() {
    let scores = Tensor::new(&[0.1, 0.2, 0.3, 0.4], &[4]);
    let result = generate_nm_mask(&scores, 5, 4);
    assert!(result.is_err(), "MSK-25 FALSIFIED: N>M should error");
}

#[test]
fn test_generate_nm_mask_not_divisible() {
    let scores = Tensor::new(&[0.1, 0.2, 0.3], &[3]); // Not divisible by 4
    let result = generate_nm_mask(&scores, 2, 4);
    assert!(
        result.is_err(),
        "MSK-26 FALSIFIED: non-divisible length should error"
    );
}

// ==========================================================================
// FALSIFICATION: Helper methods
// ==========================================================================
#[test]
fn test_mask_nnz() {
    let mask = SparsityMask::new(
        Tensor::new(&[1.0, 0.0, 1.0, 0.0, 1.0], &[5]),
        SparsityPattern::Unstructured,
    )
    .unwrap();

    assert_eq!(mask.nnz(), 3, "MSK-27 FALSIFIED: nnz should be 3");
    assert_eq!(
        mask.num_zeros(),
        2,
        "MSK-27 FALSIFIED: num_zeros should be 2"
    );
}

#[test]
fn test_dense_mask() {
    let mask = SparsityMask::dense(&[3, 4]);
    assert_eq!(
        mask.shape(),
        &[3, 4],
        "MSK-28 FALSIFIED: shape should match"
    );
    assert_eq!(
        mask.sparsity(),
        0.0,
        "MSK-28 FALSIFIED: dense mask has 0 sparsity"
    );
    assert_eq!(mask.nnz(), 12, "MSK-28 FALSIFIED: all elements non-zero");
}

// ==========================================================================
// FALSIFICATION: generate_block_mask
// ==========================================================================
#[test]
fn test_generate_block_mask_basic() {
    // 4x4 tensor with 2x2 blocks = 4 blocks
    // Prune 50% = 2 blocks
    let scores = Tensor::new(
        &[
            1.0, 1.0, 2.0, 2.0, // Row 0
            1.0, 1.0, 2.0, 2.0, // Row 1
            3.0, 3.0, 4.0, 4.0, // Row 2
            3.0, 3.0, 4.0, 4.0, // Row 3
        ],
        &[4, 4],
    );

    let mask = generate_block_mask(&scores, 2, 2, 0.5).unwrap();

    // Should prune 2 lowest blocks (sums: 4, 8, 12, 16)
    // Block (0,0) sum=4, Block (0,1) sum=8 should be pruned
    assert!(
        (mask.sparsity() - 0.5).abs() < 1e-6,
        "MSK-29 FALSIFIED: should achieve 50% sparsity"
    );
}

#[test]
fn test_generate_block_mask_uniform_blocks() {
    // All blocks should be uniform (all 0s or all 1s)
    let scores = Tensor::new(&[1.0; 16], &[4, 4]);
    let mask = generate_block_mask(&scores, 2, 2, 0.5).unwrap();

    let data = mask.tensor().data();
    // Check each 2x2 block is uniform
    for br in 0..2 {
        for bc in 0..2 {
            let first = data[br * 2 * 4 + bc * 2];
            let uniform = (0..2).all(|r| {
                (0..2).all(|c| {
                    let idx = (br * 2 + r) * 4 + (bc * 2 + c);
                    (data[idx] - first).abs() < 1e-6
                })
            });
            assert!(
                uniform,
                "MSK-30 FALSIFIED: block ({}, {}) should be uniform",
                br, bc
            );
        }
    }
}

#[path = "tests_block_mask.rs"]
mod tests_block_mask;
#[path = "tests_column_validate.rs"]
mod tests_column_validate;