aprender-core 0.30.0

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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
pub(crate) use super::*;

// ============================================================
// UNIT TESTS: Configuration
// ============================================================

#[test]
fn test_mel_config_whisper() {
    let config = MelConfig::whisper();
    assert_eq!(config.n_mels, 80);
    assert_eq!(config.n_fft, 400);
    assert_eq!(config.hop_length, 160);
    assert_eq!(config.sample_rate, 16000);
}

#[test]
fn test_mel_config_tts() {
    let config = MelConfig::tts();
    assert_eq!(config.n_mels, 80);
    assert_eq!(config.n_fft, 1024);
    assert_eq!(config.hop_length, 256);
    assert_eq!(config.sample_rate, 22050);
}

#[test]
fn test_mel_config_n_freqs() {
    let config = MelConfig::whisper();
    assert_eq!(config.n_freqs(), 201); // 400/2 + 1
}

// ============================================================
// UNIT TESTS: Mel scale conversion
// ============================================================

#[test]
fn test_hz_to_mel_zero() {
    let mel = MelFilterbank::hz_to_mel(0.0);
    assert!((mel - 0.0).abs() < 1e-5, "0 Hz should map to 0 mel");
}

#[test]
fn test_hz_to_mel_1000hz() {
    let mel = MelFilterbank::hz_to_mel(1000.0);
    assert!(
        (mel - 1000.0).abs() < 50.0,
        "1000 Hz should be close to 1000 mel, got {mel}"
    );
}

#[test]
fn test_mel_to_hz_roundtrip() {
    let frequencies = [0.0, 100.0, 500.0, 1000.0, 4000.0, 8000.0];
    for &hz in &frequencies {
        let mel = MelFilterbank::hz_to_mel(hz);
        let recovered = MelFilterbank::mel_to_hz(mel);
        assert!(
            (hz - recovered).abs() < 0.1,
            "Roundtrip failed for {hz} Hz: got {recovered}"
        );
    }
}

#[test]
fn test_mel_scale_monotonic() {
    let mut prev_mel = -1.0_f32;
    for hz in (0..8000).step_by(100) {
        let mel = MelFilterbank::hz_to_mel(hz as f32);
        assert!(
            mel > prev_mel,
            "Mel scale should be monotonically increasing"
        );
        prev_mel = mel;
    }
}

// ============================================================
// UNIT TESTS: Filterbank creation
// ============================================================

#[test]
fn test_mel_filterbank_new() {
    let config = MelConfig::whisper();
    let mel = MelFilterbank::new(&config);
    assert_eq!(mel.n_mels(), 80);
    assert_eq!(mel.n_fft(), 400);
    assert_eq!(mel.sample_rate(), 16000);
    assert_eq!(mel.n_freqs(), 201);
}

#[test]
fn test_mel_filterbank_filters_shape() {
    let config = MelConfig::whisper();
    let mel = MelFilterbank::new(&config);
    assert_eq!(mel.filters.len(), 80 * 201);
}

#[test]
fn test_mel_filterbank_filters_nonnegative() {
    let config = MelConfig::whisper();
    let mel = MelFilterbank::new(&config);
    for &f in &mel.filters {
        assert!(f >= 0.0, "Filter values should be non-negative");
    }
}

#[test]
fn test_mel_filterbank_slaney_normalization() {
    // A2/D12: Verify Slaney area normalization
    // With Slaney normalization, filter peaks are NOT bounded by 1.0
    // Instead, higher frequency filters have larger peaks (narrower bandwidth)
    let config = MelConfig::whisper();
    let mel = MelFilterbank::new(&config);

    // Find max filter value - should be > 1.0 for high frequency filters
    let max_filter_val = mel.filters.iter().cloned().fold(0.0_f32, f32::max);

    // Slaney normalization produces max values well above 1.0
    // (typically 0.01-0.05 range for area-normalized filters)
    // The key test: max should NOT be exactly 1.0 (peak normalization)
    assert!(
        (max_filter_val - 1.0).abs() > 0.001,
        "Slaney normalization should NOT produce peak=1.0, got max={:.6}",
        max_filter_val
    );

    // Verify filters are still non-negative and finite
    for &f in &mel.filters {
        assert!(f >= 0.0, "Filter values should be non-negative");
        assert!(f.is_finite(), "Filter values should be finite");
    }
}

#[test]
fn test_mel_filterbank_slaney_max_below_threshold() {
    // A2: Slaney normalization should produce max < 0.1 for Whisper config
    // This is the falsification test from the QA checklist
    let config = MelConfig::whisper();
    let mel = MelFilterbank::new(&config);

    let max_filter_val = mel.filters.iter().cloned().fold(0.0_f32, f32::max);

    assert!(
        max_filter_val < 0.1,
        "Slaney-normalized filterbank max should be < 0.1, got {:.6}",
        max_filter_val
    );
}

#[test]
fn test_hann_window_endpoints() {
    let window = MelFilterbank::hann_window(100);
    assert!(window[0] < 0.01, "Hann window should start near 0");
    assert!(window[99] < 0.01, "Hann window should end near 0");
}

#[test]
fn test_hann_window_peak() {
    let window = MelFilterbank::hann_window(100);
    let mid = window[50];
    assert!(mid > 0.9, "Hann window should peak near 1.0 in middle");
}

// ============================================================
// UNIT TESTS: Spectrogram computation
// ============================================================

#[test]
fn test_mel_compute_empty() {
    let config = MelConfig::whisper();
    let mel = MelFilterbank::new(&config);
    let result = mel.compute(&[]);
    assert!(result.is_ok());
    assert!(result.map_or(false, |v| v.is_empty()));
}

#[test]
fn test_mel_compute_short_audio() {
    let config = MelConfig::whisper();
    let mel = MelFilterbank::new(&config);
    let audio = vec![0.0; 100]; // Too short for even one frame
    let result = mel.compute(&audio);
    assert!(result.is_ok());
    assert!(result.map_or(false, |v| v.is_empty()));
}

#[test]
fn test_mel_compute_exact_one_frame() {
    // Use non-center-padded config for exact frame count test
    let config = MelConfig { center_pad: false, ..MelConfig::whisper() };
    let mel = MelFilterbank::new(&config);
    let audio = vec![0.0; 400]; // Exactly one FFT window
    let result = mel.compute(&audio).expect("compute should succeed");
    assert_eq!(result.len(), 80 * 1);
}

#[test]
fn test_mel_compute_multiple_frames() {
    // Use non-center-padded config for exact frame count test
    let config = MelConfig { center_pad: false, ..MelConfig::whisper() };
    let mel = MelFilterbank::new(&config);
    // 16000 samples = 1 second at 16kHz
    // With hop_length=160, we get (16000 - 400) / 160 + 1 = 98 frames
    let audio = vec![0.0; 16000];
    let result = mel.compute(&audio).expect("compute should succeed");
    let n_frames = result.len() / 80;
    assert_eq!(n_frames, 98);
}

#[test]
fn test_mel_compute_center_padded_frames() {
    let config = MelConfig::whisper(); // center_pad=true
    let mel = MelFilterbank::new(&config);
    // 16000 samples, center_pad=true: n_frames = 16000 / 160 = 100
    let audio = vec![0.0; 16000];
    let result = mel.compute(&audio).expect("compute should succeed");
    let n_frames = result.len() / 80;
    assert_eq!(n_frames, 100);
}

#[test]
fn test_mel_compute_sine_wave() {
    let config = MelConfig::whisper();
    let mel = MelFilterbank::new(&config);

    // Generate 1 second of 440 Hz sine wave
    let sample_rate = 16000.0;
    let freq = 440.0;
    let audio: Vec<f32> = (0..16000)
        .map(|i| (2.0 * PI * freq * i as f32 / sample_rate).sin())
        .collect();

    let result = mel.compute(&audio).expect("compute should succeed");

    let max_val = result.iter().cloned().fold(f32::NEG_INFINITY, f32::max);
    let min_val = result.iter().cloned().fold(f32::INFINITY, f32::min);

    assert!(max_val.is_finite(), "Max should be finite");
    assert!(min_val.is_finite(), "Min should be finite");
    assert!(max_val > min_val, "Should have variation in output");
}

#[test]
fn test_num_frames() {
    // Non-center-padded: n_frames = (len - n_fft) / hop + 1
    let config = MelConfig { center_pad: false, ..MelConfig::whisper() };
    let mel = MelFilterbank::new(&config);

    assert_eq!(mel.num_frames(0), 0);
    assert_eq!(mel.num_frames(100), 0);
    assert_eq!(mel.num_frames(400), 1);
    assert_eq!(mel.num_frames(560), 2);
    assert_eq!(mel.num_frames(16000), 98);
}

#[test]
fn test_num_frames_center_padded() {
    // Center-padded: n_frames = len / hop
    let config = MelConfig::whisper(); // center_pad=true
    let mel = MelFilterbank::new(&config);

    assert_eq!(mel.num_frames(0), 0);
    assert_eq!(mel.num_frames(100), 0);
    assert_eq!(mel.num_frames(160), 1);
    assert_eq!(mel.num_frames(400), 2);
    assert_eq!(mel.num_frames(16000), 100);
}

// ============================================================
// UNIT TESTS: Normalization
// ============================================================

#[test]
fn test_normalize_global_empty() {
    let config = MelConfig::whisper();
    let mel = MelFilterbank::new(&config);
    let mut data: Vec<f32> = vec![];
    mel.normalize_global(&mut data);
    assert!(data.is_empty());
}

#[test]
fn test_normalize_global_mean_zero() {
    let config = MelConfig::whisper();
    let mel = MelFilterbank::new(&config);
    let mut data = vec![1.0, 2.0, 3.0, 4.0, 5.0];
    mel.normalize_global(&mut data);

    let mean: f32 = data.iter().sum::<f32>() / data.len() as f32;
    assert!(mean.abs() < 1e-5, "Mean after normalization should be ~0");
}

#[test]
fn test_normalize_global_std_one() {
    let config = MelConfig::whisper();
    let mel = MelFilterbank::new(&config);
    let mut data = vec![1.0, 2.0, 3.0, 4.0, 5.0];
    mel.normalize_global(&mut data);

    let variance: f32 = data.iter().map(|&x| x.powi(2)).sum::<f32>() / data.len() as f32;
    let std = variance.sqrt();
    assert!(
        (std - 1.0).abs() < 1e-5,
        "Std after normalization should be ~1, got {std}"
    );
}

// ============================================================
// UNIT TESTS: Apply filterbank
// ============================================================

#[test]
fn test_apply_filterbank_shape() {
    let config = MelConfig::whisper();
    let mel = MelFilterbank::new(&config);
    let power_spec = vec![1.0; mel.n_freqs()];
    let result = mel.apply_filterbank(&power_spec);
    assert_eq!(result.len(), 80);
}

#[test]
fn test_apply_filterbank_zeros() {
    let config = MelConfig::whisper();
    let mel = MelFilterbank::new(&config);
    let power_spec = vec![0.0; mel.n_freqs()];
    let result = mel.apply_filterbank(&power_spec);
    for &val in &result {
        assert!(
            (val - 0.0).abs() < 1e-10,
            "Zero input should give zero output"
        );
    }
}

// ============================================================
// A11: Audio Clipping Detection Tests
// ============================================================

#[test]
fn test_detect_clipping_no_clipping() {
    let samples = vec![0.0, 0.5, -0.5, 0.99, -0.99];
    let report = detect_clipping(&samples);
    assert!(!report.has_clipping);
    assert_eq!(report.positive_clipped, 0);
    assert_eq!(report.negative_clipped, 0);
    assert!((report.max_value - 0.99).abs() < 1e-6);
    assert!((report.min_value - (-0.99)).abs() < 1e-6);
    assert_eq!(report.total_samples, 5);
}

#[test]
fn test_detect_clipping_positive() {
    let samples = vec![0.5, 1.5, 0.8, 2.0, 0.9];
    let report = detect_clipping(&samples);
    assert!(report.has_clipping);
    assert_eq!(report.positive_clipped, 2);
    assert_eq!(report.negative_clipped, 0);
    assert!((report.max_value - 2.0).abs() < 1e-6);
}

#[test]
fn test_detect_clipping_negative() {
    let samples = vec![-0.5, -1.5, -0.8, -2.0, -0.9];
    let report = detect_clipping(&samples);
    assert!(report.has_clipping);
    assert_eq!(report.positive_clipped, 0);
    assert_eq!(report.negative_clipped, 2);
    assert!((report.min_value - (-2.0)).abs() < 1e-6);
}

#[test]
fn test_detect_clipping_both() {
    let samples = vec![1.5, -1.5, 0.5, 2.0, -2.0];
    let report = detect_clipping(&samples);
    assert!(report.has_clipping);
    assert_eq!(report.positive_clipped, 2);
    assert_eq!(report.negative_clipped, 2);
}

#[test]
fn test_detect_clipping_empty() {
    let samples: Vec<f32> = vec![];
    let report = detect_clipping(&samples);
    assert!(!report.has_clipping);
    assert_eq!(report.total_samples, 0);
    assert!((report.clipping_percentage() - 0.0).abs() < 1e-6);
}

#[test]
fn test_detect_clipping_exactly_one() {
    let samples = vec![1.0, -1.0, 0.5];
    let report = detect_clipping(&samples);
    // Exactly 1.0 and -1.0 should NOT be clipped
    assert!(!report.has_clipping);
    assert_eq!(report.positive_clipped, 0);
    assert_eq!(report.negative_clipped, 0);
}

#[test]
fn test_clipping_percentage() {
    let samples = vec![1.5, -1.5, 0.5, 0.3, 0.2];
    let report = detect_clipping(&samples);
    // 2 out of 5 = 40%
    assert!((report.clipping_percentage() - 40.0).abs() < 1e-6);
}

#[test]
fn test_has_nan_false() {
    let samples = vec![0.0, 0.5, -0.5, 1.0, -1.0];
    assert!(!has_nan(&samples));
}

#[test]
fn test_has_nan_true() {
    let samples = vec![0.0, 0.5, f32::NAN, 1.0];
    assert!(has_nan(&samples));
}

#[test]
fn test_has_nan_empty() {
    let samples: Vec<f32> = vec![];
    assert!(!has_nan(&samples));
}

#[test]
fn test_validate_audio_valid() {
    let samples = vec![0.0, 0.5, -0.5, 0.99, -0.99];
    assert!(validate_audio(&samples).is_ok());
}

#[test]
fn test_validate_audio_empty() {
    let samples: Vec<f32> = vec![];
    let result = validate_audio(&samples);
    assert!(result.is_err());
    let msg = result.err().map(|e| e.to_string()).unwrap_or_default();
    assert!(msg.contains("empty"), "Error should mention empty: {}", msg);
}

#[test]
fn test_validate_audio_nan() {
    let samples = vec![0.0, f32::NAN, 0.5];
    let result = validate_audio(&samples);
    assert!(result.is_err());
    let msg = result.err().map(|e| e.to_string()).unwrap_or_default();
    assert!(msg.contains("NaN"), "Error should mention NaN: {}", msg);
}

#[test]
fn test_validate_audio_clipping() {
    let samples = vec![0.0, 1.5, -0.5];
    let result = validate_audio(&samples);
    assert!(result.is_err());
    let msg = result.err().map(|e| e.to_string()).unwrap_or_default();
    assert!(
        msg.contains("clipping") || msg.contains("Clipping"),
        "Error should mention clipping: {}",
        msg
    );
}

// ============================================================
// A15: Infinity Detection Tests
// ============================================================

#[test]
fn test_has_inf_false() {
    let samples = vec![0.0, 0.5, -0.5, 1.0, -1.0, f32::MAX, f32::MIN];
    assert!(!has_inf(&samples));
}

#[test]
fn test_has_inf_positive() {
    let samples = vec![0.0, f32::INFINITY, 0.5];
    assert!(has_inf(&samples));
}

#[path = "tests_validation.rs"]
mod tests_validation;