scirs2-autograd 0.3.2

Automatic differentiation module for SciRS2 (scirs2-autograd)
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
use crate::op::{ComputeContext, GradientContext, Op, OpError};
use crate::tensor::Tensor;
use crate::tensor_ops::convert_to_tensor;
use crate::Float;
use scirs2_core::ndarray::{Array2, ArrayView2, Ix2};

/// Polar decomposition: A = UP where U is unitary and P is positive semidefinite
pub struct PolarDecompositionOp;

/// Extract operation for polar decomposition components
pub struct PolarExtractOp {
    pub component: usize, // 0 for U (unitary), 1 for P (positive)
}

impl<F: Float + scirs2_core::ndarray::ScalarOperand> Op<F> for PolarDecompositionOp {
    fn name(&self) -> &'static str {
        "PolarDecomposition"
    }

    fn compute(&self, ctx: &mut ComputeContext<F>) -> Result<(), OpError> {
        let input = ctx.input(0);
        let shape = input.shape();

        if shape.len() != 2 {
            return Err(OpError::IncompatibleShape(
                "Polar decomposition requires 2D matrix".into(),
            ));
        }

        let input_2d = input
            .view()
            .into_dimensionality::<Ix2>()
            .map_err(|_| OpError::IncompatibleShape("Failed to convert to 2D".into()))?;

        let (u, p) = compute_polar_decomposition(&input_2d)?;

        ctx.append_output(u.into_dyn());
        ctx.append_output(p.into_dyn());

        Ok(())
    }

    fn grad(&self, ctx: &mut GradientContext<F>) {
        let gy = ctx.output_grad();
        let g = ctx.graph();

        // Simplified gradient - pass through
        let grad_tensor = match gy.eval(g) {
            Ok(arr) => convert_to_tensor(arr, g),
            Err(_) => {
                ctx.append_input_grad(0, None);
                return;
            }
        };

        ctx.append_input_grad(0, Some(grad_tensor));
    }
}

impl<F: Float + scirs2_core::ndarray::ScalarOperand> Op<F> for PolarExtractOp {
    fn compute(&self, ctx: &mut ComputeContext<F>) -> Result<(), OpError> {
        let input = ctx.input(0);
        let shape = input.shape();

        if shape.len() != 2 {
            return Err(OpError::IncompatibleShape(
                "Polar decomposition requires 2D matrix".into(),
            ));
        }

        let input_2d = input
            .view()
            .into_dimensionality::<Ix2>()
            .map_err(|_| OpError::IncompatibleShape("Failed to convert to 2D".into()))?;

        let (u, p) = compute_polar_decomposition(&input_2d)?;

        match self.component {
            0 => ctx.append_output(u.into_dyn()),
            1 => ctx.append_output(p.into_dyn()),
            _ => {
                return Err(OpError::Other(
                    "Invalid component index for polar decomposition".into(),
                ))
            }
        }

        Ok(())
    }

    fn grad(&self, ctx: &mut GradientContext<F>) {
        let _gy = ctx.output_grad();
        let g = ctx.graph();

        // Create a zero gradient for the input
        let zeros = crate::tensor_ops::zeros(&crate::tensor_ops::shape(ctx.input(0)), g);
        ctx.append_input_grad(0, Some(zeros));
    }
}

/// Schur decomposition: A = QTQ^T where Q is orthogonal and T is quasi-upper triangular
pub struct SchurDecompositionOp;

/// Extract operation for Schur decomposition components
pub struct SchurExtractOp {
    pub component: usize, // 0 for Q (orthogonal), 1 for T (quasi-triangular)
}

impl<F: Float + scirs2_core::ndarray::ScalarOperand> Op<F> for SchurDecompositionOp {
    fn name(&self) -> &'static str {
        "SchurDecomposition"
    }

    fn compute(&self, ctx: &mut ComputeContext<F>) -> Result<(), OpError> {
        let input = ctx.input(0);
        let shape = input.shape();

        if shape.len() != 2 || shape[0] != shape[1] {
            return Err(OpError::IncompatibleShape(
                "Schur decomposition requires square matrix".into(),
            ));
        }

        let input_2d = input
            .view()
            .into_dimensionality::<Ix2>()
            .map_err(|_| OpError::IncompatibleShape("Failed to convert to 2D".into()))?;

        let (q, t) = compute_schur_decomposition(&input_2d)?;

        ctx.append_output(q.into_dyn());
        ctx.append_output(t.into_dyn());

        Ok(())
    }

    fn grad(&self, ctx: &mut GradientContext<F>) {
        let gy = ctx.output_grad();
        let g = ctx.graph();

        // Simplified gradient
        let grad_tensor = match gy.eval(g) {
            Ok(arr) => convert_to_tensor(arr, g),
            Err(_) => {
                ctx.append_input_grad(0, None);
                return;
            }
        };

        ctx.append_input_grad(0, Some(grad_tensor));
    }
}

impl<F: Float + scirs2_core::ndarray::ScalarOperand> Op<F> for SchurExtractOp {
    fn compute(&self, ctx: &mut ComputeContext<F>) -> Result<(), OpError> {
        let input = ctx.input(0);
        let shape = input.shape();

        if shape.len() != 2 || shape[0] != shape[1] {
            return Err(OpError::IncompatibleShape(
                "Schur decomposition requires square matrix".into(),
            ));
        }

        let input_2d = input
            .view()
            .into_dimensionality::<Ix2>()
            .map_err(|_| OpError::IncompatibleShape("Failed to convert to 2D".into()))?;

        let (q, t) = compute_schur_decomposition(&input_2d)?;

        match self.component {
            0 => ctx.append_output(q.into_dyn()),
            1 => ctx.append_output(t.into_dyn()),
            _ => {
                return Err(OpError::Other(
                    "Invalid component index for Schur decomposition".into(),
                ))
            }
        }

        Ok(())
    }

    fn grad(&self, ctx: &mut GradientContext<F>) {
        let _gy = ctx.output_grad();
        let g = ctx.graph();

        // Create a zero gradient for the input
        let zeros = crate::tensor_ops::zeros(&crate::tensor_ops::shape(ctx.input(0)), g);
        ctx.append_input_grad(0, Some(zeros));
    }
}

// Helper functions

/// Compute polar decomposition A = UP
#[allow(dead_code)]
fn compute_polar_decomposition<F: Float + scirs2_core::ndarray::ScalarOperand>(
    matrix: &ArrayView2<F>,
) -> Result<(Array2<F>, Array2<F>), OpError> {
    let (m, n) = matrix.dim();

    // Use simplified SVD-based approach
    // A = UΣV^T => polar decomposition: A = (UV^T)(VΣV^T)

    // For simplicity, use power iteration to get dominant singular vectors
    let _u_vec_sigma = power_iteration_svd(
        matrix,
        20,
        F::epsilon() * F::from(100.0).expect("Failed to convert constant to float"),
    );

    if m == n && n <= 3 {
        // For small square matrices, use simplified approach

        // Compute A^T A
        let ata = matrix.t().dot(matrix);

        // P = sqrt(A^T A) - simplified using eigendecomposition approximation
        let p = matrix_sqrt(&ata.view())?;

        // U = A P^(-1) - simplified
        let u = if is_invertible(&p.view()) {
            let p_inv = matrix_inverse_simple(&p.view())?;
            matrix.dot(&p_inv)
        } else {
            // If P is singular, use pseudoinverse approximation
            Array2::<F>::eye(m)
        };

        Ok((u, p))
    } else {
        // For larger or non-square matrices, use simplified approach

        // P = sqrt(A^T A) for right polar decomposition
        let ata = matrix.t().dot(matrix);
        let p = matrix_sqrt(&ata.view())?;

        // U is approximately the identity for simplicity
        let u = if m == n {
            Array2::<F>::eye(m)
        } else {
            let mut u_approx = Array2::<F>::zeros((m, n));
            let min_dim = m.min(n);
            for i in 0..min_dim {
                u_approx[[i, i]] = F::one();
            }
            u_approx
        };

        Ok((u, p))
    }
}

/// Compute Schur decomposition A = QTQ^T
#[allow(dead_code)]
fn compute_schur_decomposition<F: Float + scirs2_core::ndarray::ScalarOperand>(
    matrix: &ArrayView2<F>,
) -> Result<(Array2<F>, Array2<F>), OpError> {
    let n = matrix.shape()[0];

    // Use QR algorithm for Schur decomposition
    let mut t = matrix.to_owned();
    let mut q = Array2::<F>::eye(n);

    let max_iter = 50;
    let tol = F::epsilon() * F::from(100.0).expect("Failed to convert constant to float");

    for _iter in 0..max_iter {
        // QR decomposition of T
        let (q_iter, r_iter) = compute_qr(&t.view())?;

        // Update T = RQ
        t = r_iter.dot(&q_iter);

        // Update Q
        q = q.dot(&q_iter);

        // Check for convergence (if T is nearly upper triangular)
        let mut off_diag_sum = F::zero();
        for i in 1..n {
            for j in 0..i {
                off_diag_sum += t[[i, j]].abs();
            }
        }

        if off_diag_sum < tol {
            break;
        }
    }

    // Ensure T is quasi-upper triangular
    for i in 2..n {
        for j in 0..(i - 1) {
            t[[i, j]] = F::zero();
        }
    }

    Ok((q, t))
}

/// Simple QR decomposition using Gram-Schmidt
#[allow(dead_code)]
fn compute_qr<F: Float>(matrix: &ArrayView2<F>) -> Result<(Array2<F>, Array2<F>), OpError> {
    let (m, n) = matrix.dim();
    let k = m.min(n);

    let mut q = Array2::<F>::zeros((m, k));
    let mut r = Array2::<F>::zeros((k, n));

    for j in 0..k {
        // Copy column j of _matrix to column j of Q
        for i in 0..m {
            q[[i, j]] = matrix[[i, j]];
        }

        // Orthogonalize against previous columns
        for i in 0..j {
            let mut dot_product = F::zero();
            for row in 0..m {
                dot_product += q[[row, i]] * q[[row, j]];
            }
            r[[i, j]] = dot_product;

            for row in 0..m {
                q[[row, j]] = q[[row, j]] - dot_product * q[[row, i]];
            }
        }

        // Normalize
        let mut norm = F::zero();
        for row in 0..m {
            norm += q[[row, j]] * q[[row, j]];
        }
        norm = norm.sqrt();

        if norm > F::epsilon() {
            r[[j, j]] = norm;
            for row in 0..m {
                q[[row, j]] /= norm;
            }
        }

        // Fill rest of R
        for col in (j + 1)..n {
            let mut dot_product = F::zero();
            for row in 0..m {
                dot_product += q[[row, j]] * matrix[[row, col]];
            }
            r[[j, col]] = dot_product;
        }
    }

    Ok((q, r))
}

/// Matrix square root using eigendecomposition (simplified)
#[allow(dead_code)]
fn matrix_sqrt<F: Float + scirs2_core::ndarray::ScalarOperand>(
    matrix: &ArrayView2<F>,
) -> Result<Array2<F>, OpError> {
    let n = matrix.shape()[0];

    // For diagonal matrices
    if is_diagonal(matrix) {
        let mut sqrt_matrix = Array2::<F>::zeros((n, n));
        for i in 0..n {
            let diag_elem = matrix[[i, i]];
            if diag_elem < F::zero() {
                return Err(OpError::Other(
                    "Cannot compute square root of negative eigenvalue".into(),
                ));
            }
            sqrt_matrix[[i, i]] = diag_elem.sqrt();
        }
        return Ok(sqrt_matrix);
    }

    // For small matrices, use simplified approach
    if n <= 2 {
        // Use Newton's method for matrix square root
        let mut x = matrix.to_owned();
        let max_iter = 20;

        for _ in 0..max_iter {
            let x_prev = x.clone();

            // X_{k+1} = 0.5 * (X_k + A * X_k^{-1})
            if let Ok(x_inv) = matrix_inverse_simple(&x.view()) {
                let ax_inv = matrix.dot(&x_inv);
                x = (&x + &ax_inv) * F::from(0.5).expect("Failed to convert constant to float");

                // Check convergence
                let diff = (&x - &x_prev).mapv(|v| v.abs()).sum();
                if diff < F::epsilon() * F::from(n as f64).expect("Failed to convert to float") {
                    break;
                }
            } else {
                // If inverse fails, return identity
                return Ok(Array2::<F>::eye(n));
            }
        }

        Ok(x)
    } else {
        // For larger matrices, use diagonal approximation
        let mut sqrt_matrix = Array2::<F>::zeros((n, n));
        for i in 0..n {
            sqrt_matrix[[i, i]] = matrix[[i, i]].abs().sqrt();
        }
        Ok(sqrt_matrix)
    }
}

/// Simple matrix inverse for small matrices
#[allow(dead_code)]
fn matrix_inverse_simple<F: Float>(matrix: &ArrayView2<F>) -> Result<Array2<F>, OpError> {
    let n = matrix.shape()[0];

    if n == 1 {
        let elem = matrix[[0, 0]];
        if elem.abs() < F::epsilon() {
            return Err(OpError::Other("Matrix is singular".into()));
        }
        let mut inv = Array2::<F>::zeros((1, 1));
        inv[[0, 0]] = F::one() / elem;
        Ok(inv)
    } else if n == 2 {
        let a = matrix[[0, 0]];
        let b = matrix[[0, 1]];
        let c = matrix[[1, 0]];
        let d = matrix[[1, 1]];

        let det = a * d - b * c;
        if det.abs() < F::epsilon() {
            return Err(OpError::Other("Matrix is singular".into()));
        }

        let mut inv = Array2::<F>::zeros((2, 2));
        inv[[0, 0]] = d / det;
        inv[[0, 1]] = -b / det;
        inv[[1, 0]] = -c / det;
        inv[[1, 1]] = a / det;

        Ok(inv)
    } else {
        // For larger matrices, use Gauss-Jordan elimination
        let mut a = matrix.to_owned();
        let mut inv = Array2::<F>::eye(n);

        for i in 0..n {
            // Find pivot
            let mut max_row = i;
            for k in (i + 1)..n {
                if a[[k, i]].abs() > a[[max_row, i]].abs() {
                    max_row = k;
                }
            }

            if a[[max_row, i]].abs() < F::epsilon() {
                return Err(OpError::Other("Matrix is singular".into()));
            }

            // Swap rows
            if max_row != i {
                for j in 0..n {
                    a.swap((i, j), (max_row, j));
                    inv.swap((i, j), (max_row, j));
                }
            }

            // Scale pivot row
            let pivot = a[[i, i]];
            for j in 0..n {
                a[[i, j]] /= pivot;
                inv[[i, j]] /= pivot;
            }

            // Eliminate column
            for k in 0..n {
                if k != i {
                    let factor = a[[k, i]];
                    for j in 0..n {
                        a[[k, j]] = a[[k, j]] - factor * a[[i, j]];
                        inv[[k, j]] = inv[[k, j]] - factor * inv[[i, j]];
                    }
                }
            }
        }

        Ok(inv)
    }
}

/// Check if matrix is diagonal
#[allow(dead_code)]
fn is_diagonal<F: Float>(matrix: &ArrayView2<F>) -> bool {
    let (m, n) = matrix.dim();
    for i in 0..m {
        for j in 0..n {
            if i != j && matrix[[i, j]].abs() > F::epsilon() {
                return false;
            }
        }
    }
    true
}

/// Check if matrix is invertible (simplified)
#[allow(dead_code)]
fn is_invertible<F: Float>(matrix: &ArrayView2<F>) -> bool {
    let n = matrix.shape()[0];

    // Simple check: diagonal dominance
    for i in 0..n {
        if matrix[[i, i]].abs() < F::epsilon() {
            return false;
        }
    }

    true
}

/// Power iteration for dominant singular value
#[allow(dead_code)]
fn power_iteration_svd<F: Float + scirs2_core::ndarray::ScalarOperand>(
    matrix: &ArrayView2<F>,
    max_iter: usize,
    tol: F,
) -> (scirs2_core::ndarray::Array1<F>, F) {
    let (m, n) = matrix.dim();

    // Initialize with random unit vector
    let mut u = scirs2_core::ndarray::Array1::<F>::zeros(m);
    u[0] = F::one();

    // Add perturbation
    for i in 1..m {
        u[i] = F::from(0.01).expect("Failed to convert constant to float")
            * F::from(i as f64).expect("Failed to convert to float");
    }

    // Normalize
    let norm = u.iter().fold(F::zero(), |acc, &x| acc + x * x).sqrt();
    if norm > F::epsilon() {
        u.mapv_inplace(|x| x / norm);
    }

    let mut prev_sigma = F::zero();

    for _iter in 0..max_iter {
        // A * u
        let au = matrix.dot(&u);

        // A^T * (A * u)
        let atau = matrix.t().dot(&au);

        // Compute norm
        let sigma = atau.iter().fold(F::zero(), |acc, &x| acc + x * x).sqrt();

        // Check convergence
        if (sigma - prev_sigma).abs() < tol {
            let au_final = matrix.dot(&u);
            let sigma_final = au_final
                .iter()
                .fold(F::zero(), |acc, &x| acc + x * x)
                .sqrt();
            return (u, sigma_final);
        }

        prev_sigma = sigma;

        // Normalize for next iteration
        let norm = atau.iter().fold(F::zero(), |acc, &x| acc + x * x).sqrt();
        if norm > F::epsilon() {
            u = atau.mapv(|x| x / norm);
        }
    }

    // Final estimate
    let au = matrix.dot(&u);
    let sigma = au.iter().fold(F::zero(), |acc, &x| acc + x * x).sqrt();
    (u, sigma)
}

// Public API functions

/// Compute polar decomposition A = UP
/// where U is unitary and P is positive semidefinite
#[allow(dead_code)]
pub fn polar<'g, F: Float + scirs2_core::ndarray::ScalarOperand>(
    matrix: &Tensor<'g, F>,
) -> (Tensor<'g, F>, Tensor<'g, F>) {
    let g = matrix.graph();

    let u = Tensor::builder(g)
        .append_input(matrix, false)
        .build(PolarExtractOp { component: 0 });

    let p = Tensor::builder(g)
        .append_input(matrix, false)
        .build(PolarExtractOp { component: 1 });

    (u, p)
}

/// Compute Schur decomposition A = QTQ^T
/// where Q is orthogonal and T is quasi-upper triangular
#[allow(dead_code)]
pub fn schur<'g, F: Float + scirs2_core::ndarray::ScalarOperand>(
    matrix: &Tensor<'g, F>,
) -> (Tensor<'g, F>, Tensor<'g, F>) {
    let g = matrix.graph();

    let q = Tensor::builder(g)
        .append_input(matrix, false)
        .build(SchurExtractOp { component: 0 });

    let t = Tensor::builder(g)
        .append_input(matrix, false)
        .build(SchurExtractOp { component: 1 });

    (q, t)
}