rustyml 0.13.0

A high-performance machine learning & deep learning library in pure Rust, offering ML algorithms and neural network support
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
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
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
//! Integration tests for `rustyml::utils::t_sne::TSNE`
//!
//! Covers constructor validation, fit_transform output shape and finiteness,
//! determinism, centered output, neighborhood preservation, error paths, and getters

use approx::assert_abs_diff_eq;
use ndarray::Array2;
use rustyml::error::Error;
use rustyml::utils::t_sne::{Init, TSNE, TSNEMethod};

// Small valid dataset (6 points, 2 features); perplexity=2.0 < 6 passes the n_samples guard
fn small_data() -> Array2<f64> {
    ndarray::array![
        [0.0, 0.0],
        [1.0, 0.0],
        [0.0, 1.0],
        [5.0, 5.0],
        [6.0, 5.0],
        [5.0, 6.0]
    ]
}

// Constructor validation - perplexity

/// perplexity = 0.0 is rejected as not positive
#[test]
fn new_perplexity_zero_returns_invalid_parameter() {
    let err = TSNE::new(2, 0.0, 200.0, 250).unwrap_err();
    assert!(
        matches!(err, Error::InvalidParameter { .. }),
        "expected InvalidParameter, got {err:?}"
    );
}

/// Negative perplexity is rejected as InvalidParameter
#[test]
fn new_perplexity_negative_returns_invalid_parameter() {
    let err = TSNE::new(2, -1.0, 200.0, 250).unwrap_err();
    assert!(
        matches!(err, Error::InvalidParameter { .. }),
        "expected InvalidParameter, got {err:?}"
    );
}

/// NaN perplexity is rejected as not finite
#[test]
fn new_perplexity_nan_returns_invalid_parameter() {
    let err = TSNE::new(2, f64::NAN, 200.0, 250).unwrap_err();
    assert!(
        matches!(err, Error::InvalidParameter { .. }),
        "expected InvalidParameter, got {err:?}"
    );
}

/// +inf perplexity is rejected as not finite
#[test]
fn new_perplexity_infinity_returns_invalid_parameter() {
    let err = TSNE::new(2, f64::INFINITY, 200.0, 250).unwrap_err();
    assert!(
        matches!(err, Error::InvalidParameter { .. }),
        "expected InvalidParameter, got {err:?}"
    );
}

// Constructor validation - learning_rate

/// learning_rate = 0.0 is rejected as not positive
#[test]
fn new_learning_rate_zero_returns_invalid_parameter() {
    let err = TSNE::new(2, 5.0, 0.0, 250).unwrap_err();
    assert!(
        matches!(err, Error::InvalidParameter { .. }),
        "expected InvalidParameter, got {err:?}"
    );
}

/// Negative learning_rate is rejected as InvalidParameter
#[test]
fn new_learning_rate_negative_returns_invalid_parameter() {
    let err = TSNE::new(2, 5.0, -100.0, 250).unwrap_err();
    assert!(
        matches!(err, Error::InvalidParameter { .. }),
        "expected InvalidParameter, got {err:?}"
    );
}

/// NaN learning_rate is rejected as not finite
#[test]
fn new_learning_rate_nan_returns_invalid_parameter() {
    let err = TSNE::new(2, 5.0, f64::NAN, 250).unwrap_err();
    assert!(
        matches!(err, Error::InvalidParameter { .. }),
        "expected InvalidParameter, got {err:?}"
    );
}

/// +inf learning_rate is rejected as not finite
#[test]
fn new_learning_rate_infinity_returns_invalid_parameter() {
    let err = TSNE::new(2, 5.0, f64::INFINITY, 250).unwrap_err();
    assert!(
        matches!(err, Error::InvalidParameter { .. }),
        "expected InvalidParameter, got {err:?}"
    );
}

// Constructor validation - n_components and n_iter

/// n_components = 0 is rejected as InvalidParameter
#[test]
fn new_n_components_zero_returns_invalid_parameter() {
    let err = TSNE::new(0, 5.0, 200.0, 250).unwrap_err();
    assert!(
        matches!(err, Error::InvalidParameter { .. }),
        "expected InvalidParameter, got {err:?}"
    );
}

/// n_iter = 0 is rejected as InvalidParameter
#[test]
fn new_n_iter_zero_returns_invalid_parameter() {
    let err = TSNE::new(2, 5.0, 200.0, 0).unwrap_err();
    assert!(
        matches!(err, Error::InvalidParameter { .. }),
        "expected InvalidParameter, got {err:?}"
    );
}

/// Valid parameters produce Ok
#[test]
fn new_valid_params_returns_ok() {
    let result = TSNE::new(2, 5.0, 200.0, 250);
    assert!(result.is_ok(), "expected Ok, got {result:?}");
}

// fit_transform - output shape

/// fit_transform on an (n, d) matrix returns an (n, n_components) matrix
#[test]
fn fit_transform_output_shape_matches_n_samples_n_components() {
    let tsne = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let x = small_data();
    let embedding = tsne.fit_transform(&x).unwrap();
    assert_eq!(
        embedding.shape(),
        &[6, 2],
        "expected shape [6, 2], got {:?}",
        embedding.shape()
    );
}

/// n_components = 1 produces an (n, 1) output
#[test]
fn fit_transform_output_shape_n_components_one() {
    let tsne = TSNE::new(1, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let x = small_data();
    let embedding = tsne.fit_transform(&x).unwrap();
    assert_eq!(
        embedding.shape(),
        &[6, 1],
        "expected shape [6, 1], got {:?}",
        embedding.shape()
    );
}

// fit_transform - all finite

/// Every element in the embedding is finite (no NaN or +/-inf)
#[test]
fn fit_transform_all_elements_finite() {
    let tsne = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let x = small_data();
    let embedding = tsne.fit_transform(&x).unwrap();
    for (idx, &v) in embedding.iter().enumerate() {
        assert!(
            v.is_finite(),
            "embedding element at flat index {idx} is not finite: {v}"
        );
    }
}

// fit_transform - determinism (same seed gives bit-identical result)

/// Two calls with the same random_state produce a bit-for-bit identical embedding
#[test]
fn fit_transform_deterministic_same_seed_gives_identical_results() {
    let x = small_data();
    let tsne1 = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let tsne2 = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let emb1 = tsne1.fit_transform(&x).unwrap();
    let emb2 = tsne2.fit_transform(&x).unwrap();
    // eps = 0.0 requires exact bit-equality
    crate::common::assert_allclose(&emb1, &emb2, 0.0_f64);
}

/// Different seeds produce different embeddings under random initialization
///
/// The seed only feeds the random initialization path; PCA initialization is deterministic
/// and would ignore the seed, so this test pins [`Init::Random`]
#[test]
fn fit_transform_different_seeds_produce_different_results() {
    let x = small_data();
    let tsne1 = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(0)
        .with_init(Init::Random)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let tsne2 = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(999)
        .with_init(Init::Random)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let emb1 = tsne1.fit_transform(&x).unwrap();
    let emb2 = tsne2.fit_transform(&x).unwrap();
    // At least one element must differ because the random initializations differ
    let any_differs = emb1.iter().zip(emb2.iter()).any(|(a, b)| a != b);
    assert!(
        any_differs,
        "expected different embeddings for different seeds, but got identical results"
    );
}

/// The default PCA initialization is deterministic, so different seeds give identical results
#[test]
fn fit_transform_pca_init_is_seed_independent() {
    let x = small_data();
    let tsne1 = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(0)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let tsne2 = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(999)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let emb1 = tsne1.fit_transform(&x).unwrap();
    let emb2 = tsne2.fit_transform(&x).unwrap();
    // PCA initialization ignores the seed, and the optimization is otherwise deterministic
    crate::common::assert_allclose(&emb1, &emb2, 0.0_f64);
}

// fit_transform - centered output

/// Each column of the final embedding has mean ~= 0 (tolerance 1e-10)
#[test]
fn fit_transform_column_means_are_zero() {
    let tsne = TSNE::new(2, 2.0, 200.0, 300)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let x = small_data();
    let embedding = tsne.fit_transform(&x).unwrap();
    let n = embedding.nrows() as f64;
    let mean0: f64 = embedding.column(0).iter().sum::<f64>() / n;
    let mean1: f64 = embedding.column(1).iter().sum::<f64>() / n;
    assert_abs_diff_eq!(mean0, 0.0, epsilon = 1e-10);
    assert_abs_diff_eq!(mean1, 0.0, epsilon = 1e-10);
}

/// n_components=1: the single output column also has mean ~= 0
#[test]
fn fit_transform_column_mean_zero_n_components_one() {
    let tsne = TSNE::new(1, 2.0, 200.0, 300)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let x = small_data();
    let embedding = tsne.fit_transform(&x).unwrap();
    let n = embedding.nrows() as f64;
    let mean0: f64 = embedding.column(0).iter().sum::<f64>() / n;
    assert_abs_diff_eq!(mean0, 0.0, epsilon = 1e-10);
}

// fit_transform - neighborhood preservation

/// Two well-separated high-D clusters remain separated in the 2-D embedding
#[test]
fn fit_transform_well_separated_clusters_remain_separated() {
    use std::f64::consts::PI;
    // 10 points evenly spaced on the unit circle; cluster B shifts every x by +200
    let n_per_cluster = 10_usize;
    let shift = 200.0_f64;
    let mut rows: Vec<[f64; 2]> = Vec::with_capacity(2 * n_per_cluster);
    for k in 0..n_per_cluster {
        let theta = 2.0 * PI * k as f64 / n_per_cluster as f64;
        rows.push([theta.cos(), theta.sin()]); // Cluster A
    }
    for k in 0..n_per_cluster {
        let theta = 2.0 * PI * k as f64 / n_per_cluster as f64;
        rows.push([shift + theta.cos(), theta.sin()]); // Cluster B
    }
    let flat: Vec<f64> = rows.iter().flat_map(|r| r.iter().copied()).collect();
    let x = Array2::from_shape_vec((2 * n_per_cluster, 2), flat).unwrap();

    // On a set this tiny (20 points) the default lr=200 over-expands the absolute
    // scale; lr=100 keeps the step sized to the data
    let tsne = TSNE::new(2, 5.0, 100.0, 1000)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let emb = tsne.fit_transform(&x).unwrap();

    // Euclidean distance between two 2-D embedding points
    let dist2d = |i: usize, j: usize| -> f64 {
        let dy0 = emb[[i, 0]] - emb[[j, 0]];
        let dy1 = emb[[i, 1]] - emb[[j, 1]];
        (dy0 * dy0 + dy1 * dy1).sqrt()
    };

    // Centroids of the two clusters in the embedding
    let cen_a: [f64; 2] = [
        (0..n_per_cluster).map(|i| emb[[i, 0]]).sum::<f64>() / n_per_cluster as f64,
        (0..n_per_cluster).map(|i| emb[[i, 1]]).sum::<f64>() / n_per_cluster as f64,
    ];
    let cen_b: [f64; 2] = [
        (n_per_cluster..2 * n_per_cluster)
            .map(|i| emb[[i, 0]])
            .sum::<f64>()
            / n_per_cluster as f64,
        (n_per_cluster..2 * n_per_cluster)
            .map(|i| emb[[i, 1]])
            .sum::<f64>()
            / n_per_cluster as f64,
    ];
    let inter_centroid = {
        let dx = cen_a[0] - cen_b[0];
        let dy = cen_a[1] - cen_b[1];
        (dx * dx + dy * dy).sqrt()
    };

    // Max intra-cluster spread
    let mut max_intra: f64 = 0.0;
    for i in 0..n_per_cluster {
        for j in (i + 1)..n_per_cluster {
            max_intra = max_intra.max(dist2d(i, j));
        }
    }
    for i in n_per_cluster..(2 * n_per_cluster) {
        for j in (i + 1)..(2 * n_per_cluster) {
            max_intra = max_intra.max(dist2d(i, j));
        }
    }

    // The two cluster centroids must be at least 5x the max intra-cluster spread apart:
    // a conservative check given the 100:1 high-D separation ratio and 1000 iterations
    assert!(
        inter_centroid > 5.0 * max_intra,
        "cluster separation weak: inter_centroid={inter_centroid:.6}, \
         max_intra={max_intra:.6}, ratio={:.3}",
        inter_centroid / max_intra.max(1e-10)
    );
}

// Error paths - fit_transform

/// perplexity == n_samples is rejected as InvalidParameter
#[test]
fn fit_transform_perplexity_equals_n_samples_returns_invalid_parameter() {
    // 5 samples, perplexity = 5.0 (= n_samples)
    let x: Array2<f64> =
        ndarray::array![[1.0, 2.0], [3.0, 4.0], [5.0, 6.0], [7.0, 8.0], [9.0, 10.0]];
    let tsne = TSNE::new(2, 5.0, 200.0, 100)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let err = tsne.fit_transform(&x).unwrap_err();
    assert!(
        matches!(err, Error::InvalidParameter { .. }),
        "expected InvalidParameter, got {err:?}"
    );
}

/// perplexity > n_samples is rejected as InvalidParameter
#[test]
fn fit_transform_perplexity_exceeds_n_samples_returns_invalid_parameter() {
    let x: Array2<f64> =
        ndarray::array![[1.0, 2.0], [3.0, 4.0], [5.0, 6.0], [7.0, 8.0], [9.0, 10.0]];
    let tsne = TSNE::new(2, 10.0, 200.0, 100)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let err = tsne.fit_transform(&x).unwrap_err();
    assert!(
        matches!(err, Error::InvalidParameter { .. }),
        "expected InvalidParameter, got {err:?}"
    );
}

/// A single sample is rejected as InvalidInput (fewer than 2 samples)
#[test]
fn fit_transform_single_sample_returns_invalid_input() {
    let x: Array2<f64> = ndarray::array![[1.0, 2.0, 3.0]];
    let tsne = TSNE::new(2, 0.5, 200.0, 50)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let err = tsne.fit_transform(&x).unwrap_err();
    assert!(
        matches!(err, Error::InvalidInput(_)),
        "expected InvalidInput, got {err:?}"
    );
}

/// Empty input (0 rows) is rejected as EmptyInput
#[test]
fn fit_transform_empty_input_returns_empty_input() {
    let x: Array2<f64> = Array2::zeros((0, 3));
    let tsne = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let err = tsne.fit_transform(&x).unwrap_err();
    assert!(
        matches!(err, Error::EmptyInput(_)),
        "expected EmptyInput, got {err:?}"
    );
}

/// NaN in input data is rejected as NonFinite
#[test]
fn fit_transform_nan_input_returns_non_finite() {
    let x = ndarray::array![[1.0, f64::NAN], [2.0, 3.0], [4.0, 5.0]];
    let tsne = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let err = tsne.fit_transform(&x).unwrap_err();
    assert!(
        matches!(err, Error::NonFinite(_)),
        "expected NonFinite, got {err:?}"
    );
}

/// +inf in input data is rejected as NonFinite
#[test]
fn fit_transform_infinity_input_returns_non_finite() {
    let x = ndarray::array![[f64::INFINITY, 1.0], [2.0, 3.0], [4.0, 5.0]];
    let tsne = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    let err = tsne.fit_transform(&x).unwrap_err();
    assert!(
        matches!(err, Error::NonFinite(_)),
        "expected NonFinite, got {err:?}"
    );
}

// Getter roundtrips

/// Getters return exactly the values passed to new()
#[test]
fn getters_return_construction_values() {
    let tsne = TSNE::new(3, 15.0, 100.0, 500)
        .unwrap()
        .with_random_state(77)
        .with_init(Init::Random)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    assert_eq!(tsne.get_n_components(), 3);
    assert_abs_diff_eq!(tsne.get_perplexity(), 15.0, epsilon = 0.0);
    assert_abs_diff_eq!(tsne.get_learning_rate(), 100.0, epsilon = 0.0);
    assert_eq!(tsne.get_n_iter(), 500);
    assert_eq!(tsne.get_random_state(), Some(77));
    assert_eq!(tsne.get_init(), Init::Random);
    assert_eq!(tsne.get_method(), TSNEMethod::Exact);
}

/// min_grad_norm defaults to 1e-7 and the builder overrides it
#[test]
fn min_grad_norm_default_and_builder() {
    let default_tsne = TSNE::new(2, 5.0, 200.0, 100).unwrap();
    assert_abs_diff_eq!(default_tsne.get_min_grad_norm(), 1e-7, epsilon = 0.0);

    let tuned = default_tsne.with_min_grad_norm(1e-3);
    assert_abs_diff_eq!(tuned.get_min_grad_norm(), 1e-3, epsilon = 0.0);
}

/// Early stopping (a large threshold stops right after early exaggeration) and disabling it
/// (threshold 0 runs the full n_iter) both produce a valid, correctly shaped embedding
#[test]
fn min_grad_norm_early_stop_and_disable_produce_valid_output() {
    let x = small_data();

    // A huge threshold makes the post-exaggeration gradient check trip immediately
    let early = TSNE::new(2, 2.0, 200.0, 1000)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap()
        .with_min_grad_norm(1e9);
    let early_embedding = early.fit_transform(&x).unwrap();
    assert_eq!(early_embedding.shape(), &[6, 2]);
    assert!(early_embedding.iter().all(|v| v.is_finite()));

    // Disabling early stopping still runs to completion with finite output
    let full = TSNE::new(2, 2.0, 200.0, 300)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap()
        .with_min_grad_norm(0.0);
    let full_embedding = full.fit_transform(&x).unwrap();
    assert_eq!(full_embedding.shape(), &[6, 2]);
    assert!(full_embedding.iter().all(|v| v.is_finite()));
}

/// When random_state is None the getter also returns None
#[test]
fn getter_random_state_none() {
    let tsne = TSNE::new(2, 5.0, 200.0, 100)
        .unwrap()
        .with_init(Init::PCA)
        .with_method(TSNEMethod::Exact)
        .unwrap();
    assert_eq!(tsne.get_random_state(), None);
}

// Barnes-Hut method

/// Barnes-Hut rejects embeddings with more than 3 components
#[test]
fn new_barnes_hut_rejects_more_than_three_components() {
    let err = TSNE::new(4, 5.0, 200.0, 100)
        .unwrap()
        .with_method(TSNEMethod::BarnesHut { angle: 0.5 })
        .unwrap_err();
    assert!(
        matches!(err, Error::InvalidParameter { .. }),
        "expected InvalidParameter for n_components=4 with Barnes-Hut, got {err:?}"
    );
}

/// Barnes-Hut accepts exactly 3 components
#[test]
fn new_barnes_hut_accepts_three_components() {
    let result = TSNE::new(3, 5.0, 200.0, 100)
        .unwrap()
        .with_method(TSNEMethod::BarnesHut { angle: 0.5 });
    assert!(
        result.is_ok(),
        "expected Ok for 3 components, got {result:?}"
    );
}

/// An angle outside [0, 1) is rejected
#[test]
fn new_barnes_hut_rejects_angle_out_of_range() {
    for bad_angle in [1.0_f64, -0.1, f64::NAN] {
        let err = TSNE::new(2, 5.0, 200.0, 100)
            .unwrap()
            .with_method(TSNEMethod::BarnesHut { angle: bad_angle })
            .unwrap_err();
        assert!(
            matches!(err, Error::InvalidParameter { .. }),
            "expected InvalidParameter for angle={bad_angle}, got {err:?}"
        );
    }
}

/// The Default instance uses Barnes-Hut with angle 0.5
#[test]
fn default_tsne_uses_barnes_hut() {
    let tsne = TSNE::default();
    assert_eq!(tsne.get_method(), TSNEMethod::BarnesHut { angle: 0.5 });
    assert_eq!(tsne.get_init(), Init::PCA);
}

/// Barnes-Hut produces an embedding of the right shape with only finite values
#[test]
fn fit_transform_barnes_hut_shape_and_finite() {
    let x = small_data();
    let tsne = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::BarnesHut { angle: 0.5 })
        .unwrap();
    let emb = tsne.fit_transform(&x).unwrap();
    assert_eq!(emb.shape(), &[6, 2]);
    for &v in emb.iter() {
        assert!(v.is_finite(), "Barnes-Hut embedding has a non-finite value");
    }
}

/// Barnes-Hut is deterministic for a fixed seed
#[test]
fn fit_transform_barnes_hut_deterministic_same_seed() {
    let x = small_data();
    let tsne1 = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(7)
        .with_init(Init::Random)
        .with_method(TSNEMethod::BarnesHut { angle: 0.5 })
        .unwrap();
    let tsne2 = TSNE::new(2, 2.0, 200.0, 100)
        .unwrap()
        .with_random_state(7)
        .with_init(Init::Random)
        .with_method(TSNEMethod::BarnesHut { angle: 0.5 })
        .unwrap();
    let emb1 = tsne1.fit_transform(&x).unwrap();
    let emb2 = tsne2.fit_transform(&x).unwrap();
    // The tree build and the sequential Z reduction keep Barnes-Hut bit-reproducible
    crate::common::assert_allclose(&emb1, &emb2, 0.0_f64);
}

/// Barnes-Hut keeps two well-separated high-D clusters apart in the embedding
#[test]
fn fit_transform_barnes_hut_well_separated_clusters_remain_separated() {
    use std::f64::consts::PI;
    let n_per_cluster = 10_usize;
    let shift = 200.0_f64;
    let mut rows: Vec<[f64; 2]> = Vec::with_capacity(2 * n_per_cluster);
    for k in 0..n_per_cluster {
        let theta = 2.0 * PI * k as f64 / n_per_cluster as f64;
        rows.push([theta.cos(), theta.sin()]); // Cluster A
    }
    for k in 0..n_per_cluster {
        let theta = 2.0 * PI * k as f64 / n_per_cluster as f64;
        rows.push([shift + theta.cos(), theta.sin()]); // Cluster B
    }
    let flat: Vec<f64> = rows.iter().flat_map(|r| r.iter().copied()).collect();
    let x = Array2::from_shape_vec((2 * n_per_cluster, 2), flat).unwrap();

    let tsne = TSNE::new(2, 5.0, 100.0, 1000)
        .unwrap()
        .with_random_state(42)
        .with_init(Init::PCA)
        .with_method(TSNEMethod::BarnesHut { angle: 0.5 })
        .unwrap();
    let emb = tsne.fit_transform(&x).unwrap();

    let dist2d = |i: usize, j: usize| -> f64 {
        let dy0 = emb[[i, 0]] - emb[[j, 0]];
        let dy1 = emb[[i, 1]] - emb[[j, 1]];
        (dy0 * dy0 + dy1 * dy1).sqrt()
    };

    let centroid = |start: usize, end: usize| -> [f64; 2] {
        let count = (end - start) as f64;
        [
            (start..end).map(|i| emb[[i, 0]]).sum::<f64>() / count,
            (start..end).map(|i| emb[[i, 1]]).sum::<f64>() / count,
        ]
    };
    let cen_a = centroid(0, n_per_cluster);
    let cen_b = centroid(n_per_cluster, 2 * n_per_cluster);
    let inter_centroid = {
        let dx = cen_a[0] - cen_b[0];
        let dy = cen_a[1] - cen_b[1];
        (dx * dx + dy * dy).sqrt()
    };

    let mut max_intra: f64 = 0.0;
    for i in 0..n_per_cluster {
        for j in (i + 1)..n_per_cluster {
            max_intra = max_intra.max(dist2d(i, j));
        }
    }
    for i in n_per_cluster..(2 * n_per_cluster) {
        for j in (i + 1)..(2 * n_per_cluster) {
            max_intra = max_intra.max(dist2d(i, j));
        }
    }

    // The approximate forces still keep the clusters clearly apart
    assert!(
        inter_centroid > 4.0 * max_intra,
        "Barnes-Hut cluster separation weak: inter_centroid={inter_centroid:.6}, \
         max_intra={max_intra:.6}, ratio={:.3}",
        inter_centroid / max_intra.max(1e-10)
    );
}