stensor 0.4.2

Cross-platform GPU tensor library with Slang and 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
use nalgebra::{Matrix3, Vector3};
use slang_hal::backend::Backend;
use slang_hal::function::GpuFunction;
use slang_hal::Shader;

#[derive(Copy, Clone, Debug)]
/// Result of a GPU SVD3 computation.
pub struct GpuSvd3 {
    /// First orthogonal matrix of the SVD.
    pub u: Matrix3<f32>,
    /// Singular values (descending order).
    pub s: Vector3<f32>,
    /// Transposed right singular vectors.
    pub vt: Matrix3<f32>,
}

#[derive(Shader)]
#[shader(module = "stensor::geometry::svd_stable::test_svd3")]
/// Test shader for SVD3.
pub struct Svd3Shader<B: Backend> {
    /// The compute function for testing SVD3.
    pub test_svd3: GpuFunction<B>,
}

#[cfg(test)]
mod test {
    use super::GpuSvd3;
    use crate::tensor::GpuTensor;
    use minislang::SlangCompiler;
    use nalgebra::Matrix3;
    use slang_hal::backend::WebGpu;
    use slang_hal::backend::{Backend, Encoder};
    use slang_hal::{BufferUsages, ShaderArgs, Shader};

    #[derive(ShaderArgs)]
    struct Svd3Args<'a, B: Backend> {
        inputs: &'a B::Buffer<f32>,
        outputs: &'a B::Buffer<f32>,
    }

    // -----------------------------------------------------------------------
    // Helpers (ported from minisvd tests)
    // -----------------------------------------------------------------------

    fn approx_eq_mat3_rel(a: &Matrix3<f32>, b: &Matrix3<f32>, eps: f32) -> bool {
        let scale_a = a.iter().map(|x| x.abs()).fold(0.0f32, f32::max);
        let scale_b = b.iter().map(|x| x.abs()).fold(0.0f32, f32::max);
        let scale = scale_a.max(scale_b).max(1e-10);
        a.iter()
            .zip(b.iter())
            .all(|(x, y)| (x - y).abs() < eps * scale)
    }

    fn assert_valid_svd(m: &Matrix3<f32>, svd: &GpuSvd3, recon_rel_eps: f32, ortho_eps: f32, label: &str) {
        // Singular values non-negative and descending.
        assert!(
            svd.s.x >= -1e-6,
            "{label}: s0 negative: {}", svd.s.x
        );
        assert!(
            svd.s.y >= -1e-6,
            "{label}: s1 negative: {}", svd.s.y
        );
        assert!(
            svd.s.z >= -1e-6,
            "{label}: s2 negative: {}", svd.s.z
        );
        assert!(
            svd.s.x + 1e-6 >= svd.s.y,
            "{label}: s0 < s1: {} < {}", svd.s.x, svd.s.y
        );
        assert!(
            svd.s.y + 1e-6 >= svd.s.z,
            "{label}: s1 < s2: {} < {}", svd.s.y, svd.s.z
        );

        // Reconstruction.
        let reconstructed = svd.u * Matrix3::from_diagonal(&svd.s) * svd.vt;
        assert!(
            approx_eq_mat3_rel(m, &reconstructed, recon_rel_eps),
            "{label}: reconstruction failed\n  original:      {m:?}\n  reconstructed: {reconstructed:?}"
        );

        // U orthogonality.
        let utu = svd.u.transpose() * svd.u;
        assert!(
            approx_eq_mat3_rel(&utu, &Matrix3::identity(), ortho_eps),
            "{label}: U not orthogonal\n  U^T*U: {utu:?}"
        );

        // V orthogonality.
        let vtv = svd.vt * svd.vt.transpose();
        assert!(
            approx_eq_mat3_rel(&vtv, &Matrix3::identity(), ortho_eps),
            "{label}: V not orthogonal\n  V^T*V: {vtv:?}"
        );
    }

    fn assert_matches_nalgebra(m: &Matrix3<f32>, svd: &GpuSvd3, rel_eps: f32, label: &str) {
        let na_svd = m.svd(true, true);
        let na_sv = na_svd.singular_values;
        let scale = na_sv[0].max(1e-10);

        assert!(
            (svd.s.x - na_sv[0]).abs() < rel_eps * scale,
            "{label}: s0 mismatch: {} vs {} (scale={scale})", svd.s.x, na_sv[0]
        );
        assert!(
            (svd.s.y - na_sv[1]).abs() < rel_eps * scale,
            "{label}: s1 mismatch: {} vs {} (scale={scale})", svd.s.y, na_sv[1]
        );
        assert!(
            (svd.s.z - na_sv[2]).abs() < rel_eps * scale,
            "{label}: s2 mismatch: {} vs {} (scale={scale})", svd.s.z, na_sv[2]
        );
    }

    /// Minimal xorshift32 PRNG.
    struct Rng(u32);

    impl Rng {
        fn new(seed: u32) -> Self {
            Self(seed)
        }

        fn next_u32(&mut self) -> u32 {
            self.0 ^= self.0 << 13;
            self.0 ^= self.0 >> 17;
            self.0 ^= self.0 << 5;
            self.0
        }

        fn next_f32_range(&mut self, lo: f32, hi: f32) -> f32 {
            let t = (self.next_u32() as f64) / (u32::MAX as f64);
            lo + (hi - lo) * t as f32
        }

        /// Random 3x3 matrix (column-major) with elements in [lo, hi).
        fn next_mat3(&mut self, lo: f32, hi: f32) -> Matrix3<f32> {
            let mut arr = [0.0f32; 9];
            for v in &mut arr {
                *v = self.next_f32_range(lo, hi);
            }
            Matrix3::from_column_slice(&arr)
        }
    }

    // -----------------------------------------------------------------------
    // GPU dispatch helpers
    // -----------------------------------------------------------------------

    /// Packs matrices into a flat f32 buffer (9 floats per matrix, column-major).
    fn pack_matrices(matrices: &[Matrix3<f32>]) -> Vec<f32> {
        let mut data = Vec::with_capacity(matrices.len() * 9);
        for m in matrices {
            for &v in m.as_slice() {
                data.push(v);
            }
        }
        data
    }

    /// Unpacks SVD results from a flat f32 buffer (21 floats per result).
    fn unpack_svd_results(data: &[f32], count: usize) -> Vec<GpuSvd3> {
        let mut results = Vec::with_capacity(count);
        for i in 0..count {
            let base = i * 21;
            let u = Matrix3::from_column_slice(&data[base..base + 9]);
            let s = nalgebra::Vector3::new(data[base + 9], data[base + 10], data[base + 11]);
            let vt = Matrix3::from_column_slice(&data[base + 12..base + 21]);
            results.push(GpuSvd3 { u, s, vt });
        }
        results
    }

    /// Runs SVD3 on the GPU for the given matrices and returns the results.
    async fn run_gpu_svd3(backend: &impl Backend, matrices: &[Matrix3<f32>]) -> Vec<GpuSvd3> {
        let mut compiler = SlangCompiler::new(vec![]);
        crate::register_shaders(&mut compiler);

        let shader = super::Svd3Shader::from_backend(backend, &compiler).unwrap();

        let input_data = pack_matrices(matrices);
        let count = matrices.len();

        let gpu_inputs =
            GpuTensor::vector(backend, &input_data, BufferUsages::STORAGE).unwrap();
        let output_len = count * 21;
        let gpu_outputs = GpuTensor::<f32, _>::vector(
            backend,
            &vec![0.0f32; output_len],
            BufferUsages::STORAGE | BufferUsages::COPY_SRC,
        )
        .unwrap();

        let mut encoder = backend.begin_encoding();
        let mut pass = encoder.begin_pass("test_svd3", None);
        let args = Svd3Args {
            inputs: gpu_inputs.buffer(),
            outputs: gpu_outputs.buffer(),
        };
        shader
            .test_svd3
            .launch(backend, &mut pass, &args, [count as u32, 1, 1])
            .unwrap();
        drop(pass);

        backend.submit(encoder).unwrap();
        backend.synchronize().unwrap();

        let mut output_data = vec![0.0f32; output_len];
        backend
            .slow_read_buffer(gpu_outputs.buffer(), &mut output_data)
            .await
            .unwrap();

        unpack_svd_results(&output_data, count)
    }

    // -----------------------------------------------------------------------
    // Tests
    // -----------------------------------------------------------------------

    #[futures_test::test]
    #[serial_test::serial]
    async fn gpu_svd3_webgpu() {
        let backend = WebGpu::default().await.unwrap();
        gpu_svd3_all(&backend).await;
    }

    #[futures_test::test]
    #[serial_test::serial]
    #[cfg(feature = "cuda")]
    async fn gpu_svd3_cuda() {
        let backend = slang_hal::cuda::Cuda::new().unwrap();
        gpu_svd3_all(&backend).await;
    }

    async fn gpu_svd3_all(backend: &impl Backend) {
        gpu_svd3_deterministic(backend).await;
        gpu_svd3_random_unit_range(backend).await;
        gpu_svd3_random_large_range(backend).await;
        gpu_svd3_random_small_values(backend).await;
        gpu_svd3_random_positive_definite(backend).await;
        gpu_svd3_random_symmetric(backend).await;
        gpu_svd3_random_rank_deficient(backend).await;
        gpu_svd3_random_near_singular(backend).await;
        gpu_svd3_random_negative_determinant(backend).await;
    }

    async fn gpu_svd3_deterministic(backend: &impl Backend) {
        use nalgebra::Vector3;

        let identity = Matrix3::identity();
        let diagonal = Matrix3::from_columns(&[
            Vector3::new(3.0, 0.0, 0.0),
            Vector3::new(0.0, 2.0, 0.0),
            Vector3::new(0.0, 0.0, 1.0),
        ]);
        let symmetric = Matrix3::from_columns(&[
            Vector3::new(2.0, 1.0, 0.0),
            Vector3::new(1.0, 3.0, 1.0),
            Vector3::new(0.0, 1.0, 2.0),
        ]);
        let general = Matrix3::from_columns(&[
            Vector3::new(1.0, 4.0, 7.0),
            Vector3::new(2.0, 5.0, 8.0),
            Vector3::new(3.0, 6.0, 10.0),
        ]);
        let zero = Matrix3::zeros();

        let v = Vector3::new(1.0, 2.0, 3.0);
        let w = Vector3::new(4.0, 5.0, 6.0);
        let rank_one = Matrix3::from_columns(&[v * w.x, v * w.y, v * w.z]);

        let mixed_sign = Matrix3::from_columns(&[
            Vector3::new(0.5, -1.2, 3.7),
            Vector3::new(2.1, 0.3, -0.8),
            Vector3::new(-1.0, 4.5, 2.2),
        ]);
        let large_values = Matrix3::from_columns(&[
            Vector3::new(100.0, 0.01, -50.0),
            Vector3::new(0.01, 200.0, 30.0),
            Vector3::new(-50.0, 30.0, 150.0),
        ]);

        let matrices = vec![identity, diagonal, symmetric, general, zero, rank_one, mixed_sign, large_values];
        let labels = ["identity", "diagonal", "symmetric", "general", "zero", "rank_one", "mixed_sign", "large_values"];

        let results = run_gpu_svd3(backend, &matrices).await;

        // Identity: singular values should all be 1.
        assert!((results[0].s.x - 1.0).abs() < 1e-6, "identity s0: {}", results[0].s.x);
        assert!((results[0].s.y - 1.0).abs() < 1e-6, "identity s1: {}", results[0].s.y);
        assert!((results[0].s.z - 1.0).abs() < 1e-6, "identity s2: {}", results[0].s.z);

        // Diagonal: singular values should be 3, 2, 1.
        assert!((results[1].s.x - 3.0).abs() < 1e-6, "diagonal s0: {}", results[1].s.x);
        assert!((results[1].s.y - 2.0).abs() < 1e-6, "diagonal s1: {}", results[1].s.y);
        assert!((results[1].s.z - 1.0).abs() < 1e-6, "diagonal s2: {}", results[1].s.z);

        // Zero: singular values should all be 0.
        assert!(results[4].s.x.abs() < 1e-6, "zero s0: {}", results[4].s.x);
        assert!(results[4].s.y.abs() < 1e-6, "zero s1: {}", results[4].s.y);
        assert!(results[4].s.z.abs() < 1e-6, "zero s2: {}", results[4].s.z);

        // Rank one: only first singular value should be large.
        assert!(results[5].s.x > 1e-3, "rank_one s0: {}", results[5].s.x);
        assert!(results[5].s.y < 1e-4, "rank_one s1: {}", results[5].s.y);
        assert!(results[5].s.z < 1e-4, "rank_one s2: {}", results[5].s.z);

        // All except zero: validate SVD properties.
        for (i, (m, svd)) in matrices.iter().zip(results.iter()).enumerate() {
            if labels[i] == "zero" {
                continue;
            }
            assert_valid_svd(m, svd, 1e-4, 1e-4, labels[i]);
        }

        // Cross-validate with nalgebra.
        for (i, (m, svd)) in matrices.iter().zip(results.iter()).enumerate() {
            if labels[i] == "zero" {
                continue;
            }
            assert_matches_nalgebra(m, svd, 1e-4, labels[i]);
        }
    }

    async fn gpu_svd3_random_unit_range(backend: &impl Backend) {
        let mut rng = Rng::new(0xDEAD_BEEF);
        let matrices: Vec<_> = (0..1000).map(|_| rng.next_mat3(-1.0, 1.0)).collect();
        let results = run_gpu_svd3(backend, &matrices).await;

        for (i, (m, svd)) in matrices.iter().zip(results.iter()).enumerate() {
            let label = format!("random_unit_{i}");
            assert_valid_svd(m, svd, 1e-4, 1e-4, &label);
            assert_matches_nalgebra(m, svd, 1e-4, &label);
        }
    }

    async fn gpu_svd3_random_large_range(backend: &impl Backend) {
        let mut rng = Rng::new(0xCAFE_1234);
        let matrices: Vec<_> = (0..1000).map(|_| rng.next_mat3(-100.0, 100.0)).collect();
        let results = run_gpu_svd3(backend, &matrices).await;

        for (i, (m, svd)) in matrices.iter().zip(results.iter()).enumerate() {
            let label = format!("random_large_{i}");
            assert_valid_svd(m, svd, 1e-4, 1e-4, &label);
            assert_matches_nalgebra(m, svd, 1e-4, &label);
        }
    }

    async fn gpu_svd3_random_small_values(backend: &impl Backend) {
        let mut rng = Rng::new(0xBAAD_F00D);
        let matrices: Vec<_> = (0..1000).map(|_| rng.next_mat3(-1e-3, 1e-3)).collect();
        let results = run_gpu_svd3(backend, &matrices).await;

        for (i, (m, svd)) in matrices.iter().zip(results.iter()).enumerate() {
            let label = format!("random_small_{i}");
            assert_valid_svd(m, svd, 1e-4, 1e-4, &label);
            assert_matches_nalgebra(m, svd, 1e-4, &label);
        }
    }

    async fn gpu_svd3_random_positive_definite(backend: &impl Backend) {
        let mut rng = Rng::new(0x1234_ABCD);
        let matrices: Vec<_> = (0..500)
            .map(|_| {
                let a = rng.next_mat3(-5.0, 5.0);
                a.transpose() * a
            })
            .collect();
        let results = run_gpu_svd3(backend, &matrices).await;

        for (i, (m, svd)) in matrices.iter().zip(results.iter()).enumerate() {
            let label = format!("random_posdef_{i}");
            assert_valid_svd(m, svd, 1e-3, 1e-4, &label);
            assert_matches_nalgebra(m, svd, 1e-4, &label);
        }
    }

    async fn gpu_svd3_random_symmetric(backend: &impl Backend) {
        let mut rng = Rng::new(0xFEED_FACE);
        let matrices: Vec<_> = (0..500)
            .map(|_| {
                let a = rng.next_mat3(-10.0, 10.0);
                (a + a.transpose()) * 0.5
            })
            .collect();
        let results = run_gpu_svd3(backend, &matrices).await;

        for (i, (m, svd)) in matrices.iter().zip(results.iter()).enumerate() {
            let label = format!("random_symmetric_{i}");
            assert_valid_svd(m, svd, 1e-4, 1e-4, &label);
            assert_matches_nalgebra(m, svd, 1e-4, &label);
        }
    }

    async fn gpu_svd3_random_rank_deficient(backend: &impl Backend) {
        let mut rng = Rng::new(0xABCD_EF01);
        let matrices: Vec<_> = (0..500)
            .map(|_| {
                let c0 = nalgebra::Vector3::new(
                    rng.next_f32_range(-5.0, 5.0),
                    rng.next_f32_range(-5.0, 5.0),
                    rng.next_f32_range(-5.0, 5.0),
                );
                let c1 = nalgebra::Vector3::new(
                    rng.next_f32_range(-5.0, 5.0),
                    rng.next_f32_range(-5.0, 5.0),
                    rng.next_f32_range(-5.0, 5.0),
                );
                let alpha = rng.next_f32_range(-3.0, 3.0);
                let beta = rng.next_f32_range(-3.0, 3.0);
                let c2 = c0 * alpha + c1 * beta;
                Matrix3::from_columns(&[c0, c1, c2])
            })
            .collect();
        let results = run_gpu_svd3(backend, &matrices).await;

        for (i, (m, svd)) in matrices.iter().zip(results.iter()).enumerate() {
            let label = format!("random_rank2_{i}");
            assert!(
                svd.s.z < 1e-3,
                "{label}: expected near-zero s2, got {}", svd.s.z
            );
            assert_valid_svd(m, svd, 1e-3, 1e-4, &label);
        }
    }

    async fn gpu_svd3_random_near_singular(backend: &impl Backend) {
        let mut rng = Rng::new(0x1111_2222);
        let matrices: Vec<_> = (0..500)
            .map(|_| {
                let mut arr = [0.0f32; 9];
                arr[0] = 1.0;
                arr[4] = 1.0;
                arr[8] = 1.0;
                for v in &mut arr {
                    *v += rng.next_f32_range(-0.01, 0.01);
                }
                arr[6] = arr[0] * rng.next_f32_range(-0.001, 0.001)
                    + arr[3] * rng.next_f32_range(-0.001, 0.001);
                arr[7] = arr[1] * rng.next_f32_range(-0.001, 0.001)
                    + arr[4] * rng.next_f32_range(-0.001, 0.001);
                arr[8] = arr[2] * rng.next_f32_range(-0.001, 0.001)
                    + arr[5] * rng.next_f32_range(-0.001, 0.001);
                Matrix3::from_column_slice(&arr)
            })
            .collect();
        let results = run_gpu_svd3(backend, &matrices).await;

        for (i, (m, svd)) in matrices.iter().zip(results.iter()).enumerate() {
            let label = format!("random_near_singular_{i}");
            assert_valid_svd(m, svd, 1e-4, 1e-4, &label);
        }
    }

    async fn gpu_svd3_random_negative_determinant(backend: &impl Backend) {
        let mut rng = Rng::new(0x5555_AAAA);
        let matrices: Vec<_> = (0..500)
            .map(|_| {
                let mut m = rng.next_mat3(-5.0, 5.0);
                m.set_column(0, &(-m.column(0)));
                m
            })
            .collect();
        let results = run_gpu_svd3(backend, &matrices).await;

        for (i, (m, svd)) in matrices.iter().zip(results.iter()).enumerate() {
            let label = format!("random_negdet_{i}");
            assert_valid_svd(m, svd, 1e-4, 1e-4, &label);
            assert_matches_nalgebra(m, svd, 1e-4, &label);
        }
    }
}