numrs2 0.3.3

A Rust implementation inspired by NumPy for numerical computing (NumRS2)
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
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
//! Enhanced sparse matrix operations with advanced algorithms and optimizations
//!
//! This module provides advanced sparse matrix operations including:
//! - Optimized sparse-dense matrix operations
//! - Iterative linear solvers (CG, GMRES, BiCGSTAB)
//! - Sparse matrix decompositions (ILU, Cholesky)
//! - Advanced storage formats and conversions
//! - SIMD-accelerated operations where applicable

use crate::array::Array;
use crate::error::{NumRs2Error, Result};
use crate::sparse::{SparseMatrix, SparseMatrixFormat};
use num_traits::{Float, One, Zero};
use std::fmt::Debug;

/// Enhanced sparse matrix operations with advanced algorithms
pub struct SparseOpsAdvanced;

impl SparseOpsAdvanced {
    /// Sparse-dense matrix multiplication with optimized memory access patterns
    ///
    /// Computes C = alpha * A * B + beta * C where A is sparse and B, C are dense
    pub fn spmv_dense<T>(
        a: &SparseMatrix<T>,
        x: &Array<T>,
        y: &mut Array<T>,
        alpha: T,
        beta: T,
    ) -> Result<()>
    where
        T: Float + Clone + Debug,
    {
        let a_shape = a.shape();
        let x_shape = x.shape();
        let y_shape = y.shape();

        if a_shape.len() != 2 || x_shape.len() != 1 || y_shape.len() != 1 {
            return Err(NumRs2Error::DimensionMismatch(
                "Sparse-dense multiplication requires 2D sparse matrix and 1D dense vectors"
                    .to_string(),
            ));
        }

        if a_shape[1] != x_shape[0] || a_shape[0] != y_shape[0] {
            return Err(NumRs2Error::DimensionMismatch(
                "Matrix-vector dimensions incompatible".to_string(),
            ));
        }

        let m = a_shape[0];
        let n = a_shape[1];

        // Apply beta scaling to y first
        if beta != T::one() {
            for i in 0..m {
                let val = y.get(&[i])?;
                y.set(&[i], beta * val)?;
            }
        }

        // Perform sparse matrix-vector multiplication
        // Use format-specific optimizations
        match a.format {
            SparseMatrixFormat::CSR => Self::spmv_csr(a, x, y, alpha),
            SparseMatrixFormat::CSC => Self::spmv_csc(a, x, y, alpha),
            _ => Self::spmv_coo(a, x, y, alpha, m, n),
        }
    }

    /// CSR format sparse matrix-vector multiplication
    fn spmv_csr<T>(a: &SparseMatrix<T>, x: &Array<T>, y: &mut Array<T>, alpha: T) -> Result<()>
    where
        T: Float + Clone + Debug,
    {
        if let (Some(indptr), Some(indices)) = (&a.indptr, &a.indices) {
            let m = a.shape()[0];

            for i in 0..m {
                let row_start = indptr[i];
                let row_end = indptr[i + 1];

                let mut sum = T::zero();
                for idx in row_start..row_end {
                    let j = indices[idx];
                    let a_val = a.get(i, j)?;
                    let x_val = x.get(&[j])?;
                    sum = sum + a_val * x_val;
                }

                let current = y.get(&[i])?;
                y.set(&[i], current + alpha * sum)?;
            }
        } else {
            return Err(NumRs2Error::ComputationError(
                "CSR format data not available".to_string(),
            ));
        }

        Ok(())
    }

    /// CSC format sparse matrix-vector multiplication
    fn spmv_csc<T>(a: &SparseMatrix<T>, x: &Array<T>, y: &mut Array<T>, alpha: T) -> Result<()>
    where
        T: Float + Clone + Debug,
    {
        if let (Some(indptr), Some(indices)) = (&a.indptr, &a.indices) {
            let n = a.shape()[1];

            for j in 0..n {
                let col_start = indptr[j];
                let col_end = indptr[j + 1];

                let x_val = x.get(&[j])?;
                let scaled_x = alpha * x_val;

                for idx in col_start..col_end {
                    let i = indices[idx];
                    let a_val = a.get(i, j)?;
                    let current = y.get(&[i])?;
                    y.set(&[i], current + a_val * scaled_x)?;
                }
            }
        } else {
            return Err(NumRs2Error::ComputationError(
                "CSC format data not available".to_string(),
            ));
        }

        Ok(())
    }

    /// COO format sparse matrix-vector multiplication
    fn spmv_coo<T>(
        a: &SparseMatrix<T>,
        x: &Array<T>,
        y: &mut Array<T>,
        alpha: T,
        m: usize,
        n: usize,
    ) -> Result<()>
    where
        T: Float + Clone + Debug,
    {
        // For COO format, iterate through all non-zero entries
        for (indices, value) in &a.array.data {
            let i = indices[0];
            let j = indices[1];

            if i < m && j < n {
                let x_val = x.get(&[j])?;
                let current = y.get(&[i])?;
                y.set(&[i], current + alpha * *value * x_val)?;
            }
        }

        Ok(())
    }

    /// Optimized sparse matrix-matrix multiplication
    pub fn spgemm<T>(a: &SparseMatrix<T>, b: &SparseMatrix<T>) -> Result<SparseMatrix<T>>
    where
        T: Float + Clone + Debug + Zero + One,
    {
        // Use the existing matmul implementation but with optimizations
        let mut result = a.matmul(b)?;

        // Convert result to most efficient format based on sparsity pattern
        let density = result.density();

        if density < 0.1 {
            // Very sparse - keep as COO or convert to CSR for row operations
            result.format = SparseMatrixFormat::CSR;
        } else if density < 0.3 {
            // Moderately sparse - CSR is usually good
            result.to_csr()?;
        } else {
            // Dense enough that conversion overhead might not be worth it
            result.format = SparseMatrixFormat::COO;
        }

        Ok(result)
    }

    /// Conjugate Gradient solver for sparse symmetric positive definite systems
    pub fn solve_cg<T>(
        a: &SparseMatrix<T>,
        b: &Array<T>,
        x0: Option<&Array<T>>,
        tol: T,
        max_iter: usize,
    ) -> Result<(Array<T>, usize, T)>
    where
        T: Float + Clone + Debug,
    {
        let n = a.shape()[0];

        if a.shape()[1] != n {
            return Err(NumRs2Error::DimensionMismatch(
                "Matrix must be square for CG solver".to_string(),
            ));
        }

        if b.shape()[0] != n {
            return Err(NumRs2Error::DimensionMismatch(
                "Right-hand side vector dimension mismatch".to_string(),
            ));
        }

        // Initialize solution vector
        let mut x = if let Some(x_init) = x0 {
            x_init.clone()
        } else {
            Array::zeros(&[n])
        };

        // Compute initial residual: r = b - A*x
        let mut ax = Array::zeros(&[n]);
        Self::spmv_dense(a, &x, &mut ax, T::one(), T::zero())?;

        let mut r = Array::zeros(&[n]);
        for i in 0..n {
            let b_val = b.get(&[i])?;
            let ax_val = ax.get(&[i])?;
            r.set(&[i], b_val - ax_val)?;
        }

        let mut p = r.clone();
        let mut rsold = Self::dot_product(&r, &r)?;

        let tol_sq = tol * tol;

        for iter in 0..max_iter {
            // Check convergence
            if rsold < tol_sq {
                return Ok((x, iter, rsold.sqrt()));
            }

            // Compute A*p
            let mut ap = Array::zeros(&[n]);
            Self::spmv_dense(a, &p, &mut ap, T::one(), T::zero())?;

            // Compute alpha = rsold / (p^T * A * p)
            let ptap = Self::dot_product(&p, &ap)?;
            if ptap.abs() < T::epsilon() {
                return Err(NumRs2Error::ComputationError(
                    "CG solver breakdown: p^T * A * p = 0".to_string(),
                ));
            }

            let alpha = rsold / ptap;

            // Update solution: x = x + alpha * p
            for i in 0..n {
                let x_val = x.get(&[i])?;
                let p_val = p.get(&[i])?;
                x.set(&[i], x_val + alpha * p_val)?;
            }

            // Update residual: r = r - alpha * A * p
            for i in 0..n {
                let r_val = r.get(&[i])?;
                let ap_val = ap.get(&[i])?;
                r.set(&[i], r_val - alpha * ap_val)?;
            }

            let rsnew = Self::dot_product(&r, &r)?;

            // Check convergence
            if rsnew < tol_sq {
                return Ok((x, iter + 1, rsnew.sqrt()));
            }

            // Update search direction: p = r + beta * p
            let beta = rsnew / rsold;
            for i in 0..n {
                let r_val = r.get(&[i])?;
                let p_val = p.get(&[i])?;
                p.set(&[i], r_val + beta * p_val)?;
            }

            rsold = rsnew;
        }

        Ok((x, max_iter, rsold.sqrt()))
    }

    /// BiCGSTAB solver for general sparse systems
    pub fn solve_bicgstab<T>(
        a: &SparseMatrix<T>,
        b: &Array<T>,
        x0: Option<&Array<T>>,
        tol: T,
        max_iter: usize,
    ) -> Result<(Array<T>, usize, T)>
    where
        T: Float + Clone + Debug,
    {
        let n = a.shape()[0];

        if a.shape()[1] != n {
            return Err(NumRs2Error::DimensionMismatch(
                "Matrix must be square for BiCGSTAB solver".to_string(),
            ));
        }

        // Initialize solution vector
        let mut x = if let Some(x_init) = x0 {
            x_init.clone()
        } else {
            Array::zeros(&[n])
        };

        // Compute initial residual: r = b - A*x
        let mut ax = Array::zeros(&[n]);
        Self::spmv_dense(a, &x, &mut ax, T::one(), T::zero())?;

        let mut r = Array::zeros(&[n]);
        for i in 0..n {
            let b_val = b.get(&[i])?;
            let ax_val = ax.get(&[i])?;
            r.set(&[i], b_val - ax_val)?;
        }

        let r0 = r.clone();
        let mut p = r.clone();
        let mut v = Array::zeros(&[n]);
        let mut s = Array::zeros(&[n]);
        let mut t = Array::zeros(&[n]);

        let mut rho = T::one();
        let mut alpha = T::one();
        let mut omega = T::one();

        let tol_sq = tol * tol;

        for iter in 0..max_iter {
            let r_norm_sq = Self::dot_product(&r, &r)?;

            // Check convergence
            if r_norm_sq < tol_sq {
                return Ok((x, iter, r_norm_sq.sqrt()));
            }

            let rho_new = Self::dot_product(&r0, &r)?;

            if rho_new.abs() < T::epsilon() {
                return Err(NumRs2Error::ComputationError(
                    "BiCGSTAB solver breakdown: rho = 0".to_string(),
                ));
            }

            let beta = (rho_new / rho) * (alpha / omega);

            // Update p = r + beta * (p - omega * v)
            for i in 0..n {
                let r_val = r.get(&[i])?;
                let p_val = p.get(&[i])?;
                let v_val = v.get(&[i])?;
                p.set(&[i], r_val + beta * (p_val - omega * v_val))?;
            }

            // v = A * p
            Self::spmv_dense(a, &p, &mut v, T::one(), T::zero())?;

            let r0v = Self::dot_product(&r0, &v)?;
            if r0v.abs() < T::epsilon() {
                return Err(NumRs2Error::ComputationError(
                    "BiCGSTAB solver breakdown: r0^T * v = 0".to_string(),
                ));
            }

            alpha = rho_new / r0v;

            // s = r - alpha * v
            for i in 0..n {
                let r_val = r.get(&[i])?;
                let v_val = v.get(&[i])?;
                s.set(&[i], r_val - alpha * v_val)?;
            }

            // Check if we can stop here
            let s_norm_sq = Self::dot_product(&s, &s)?;
            if s_norm_sq < tol_sq {
                // Update x and return
                for i in 0..n {
                    let x_val = x.get(&[i])?;
                    let p_val = p.get(&[i])?;
                    x.set(&[i], x_val + alpha * p_val)?;
                }
                return Ok((x, iter + 1, s_norm_sq.sqrt()));
            }

            // t = A * s
            Self::spmv_dense(a, &s, &mut t, T::one(), T::zero())?;

            let ts = Self::dot_product(&t, &s)?;
            let tt = Self::dot_product(&t, &t)?;

            if tt.abs() < T::epsilon() {
                return Err(NumRs2Error::ComputationError(
                    "BiCGSTAB solver breakdown: t^T * t = 0".to_string(),
                ));
            }

            omega = ts / tt;

            // Update solution: x = x + alpha * p + omega * s
            for i in 0..n {
                let x_val = x.get(&[i])?;
                let p_val = p.get(&[i])?;
                let s_val = s.get(&[i])?;
                x.set(&[i], x_val + alpha * p_val + omega * s_val)?;
            }

            // Update residual: r = s - omega * t
            for i in 0..n {
                let s_val = s.get(&[i])?;
                let t_val = t.get(&[i])?;
                r.set(&[i], s_val - omega * t_val)?;
            }

            rho = rho_new;

            if omega.abs() < T::epsilon() {
                return Err(NumRs2Error::ComputationError(
                    "BiCGSTAB solver breakdown: omega = 0".to_string(),
                ));
            }
        }

        let final_residual = Self::dot_product(&r, &r)?.sqrt();
        Ok((x, max_iter, final_residual))
    }

    /// GMRES (Generalized Minimal Residual) solver for sparse non-symmetric systems
    ///
    /// This is the sparse matrix variant of GMRES, optimized for sparse matrices.
    /// It uses restarted GMRES with Arnoldi iteration and Givens rotations.
    ///
    /// # Arguments
    ///
    /// * `a` - Sparse coefficient matrix (must be square)
    /// * `b` - Right-hand side vector
    /// * `x0` - Optional initial guess (zeros if None)
    /// * `tol` - Convergence tolerance
    /// * `max_iter` - Maximum number of iterations
    /// * `restart` - Restart parameter (Krylov subspace dimension)
    ///
    /// # Returns
    ///
    /// Tuple of (solution, iterations, final_residual_norm)
    pub fn solve_gmres<T>(
        a: &SparseMatrix<T>,
        b: &Array<T>,
        x0: Option<&Array<T>>,
        tol: T,
        max_iter: usize,
        restart: usize,
    ) -> Result<(Array<T>, usize, T)>
    where
        T: Float + Clone + Debug,
    {
        let n = a.shape()[0];

        if a.shape()[1] != n {
            return Err(NumRs2Error::DimensionMismatch(
                "Matrix must be square for GMRES solver".to_string(),
            ));
        }

        if b.shape()[0] != n {
            return Err(NumRs2Error::DimensionMismatch(
                "Right-hand side dimension mismatch".to_string(),
            ));
        }

        let restart = restart.min(n);

        // Initialize solution vector
        let mut x = if let Some(x_init) = x0 {
            x_init.clone()
        } else {
            Array::zeros(&[n])
        };

        // Compute b norm for relative residual check
        let b_norm = Self::dot_product(b, b)?.sqrt();
        if b_norm.is_zero() {
            return Ok((x, 0, T::zero()));
        }

        let mut total_iter = 0;

        // Outer iteration (restarts)
        for _ in 0..(max_iter / restart + 1) {
            // Compute residual r = b - Ax
            let mut ax = Array::zeros(&[n]);
            Self::spmv_dense(a, &x, &mut ax, T::one(), T::zero())?;

            let mut r = Array::zeros(&[n]);
            for i in 0..n {
                let b_val = b.get(&[i])?;
                let ax_val = ax.get(&[i])?;
                r.set(&[i], b_val - ax_val)?;
            }

            let r_norm = Self::dot_product(&r, &r)?.sqrt();

            // Check convergence
            if r_norm / b_norm < tol {
                return Ok((x, total_iter, r_norm));
            }

            // Initialize Arnoldi iteration
            let mut v = vec![Array::zeros(&[n]); restart + 1];
            for i in 0..n {
                v[0].set(&[i], r.get(&[i])? / r_norm)?;
            }

            let mut h = vec![vec![T::zero(); restart]; restart + 1];
            let mut g = vec![T::zero(); restart + 1];
            g[0] = r_norm;

            // Givens rotation coefficients
            let mut cs_vec = vec![T::zero(); restart];
            let mut sn_vec = vec![T::zero(); restart];

            let mut k = 0;
            for j in 0..restart {
                if total_iter >= max_iter {
                    break;
                }
                total_iter += 1;

                // Arnoldi step: w = A * v[j]
                let mut w = Array::zeros(&[n]);
                Self::spmv_dense(a, &v[j], &mut w, T::one(), T::zero())?;

                // Modified Gram-Schmidt orthogonalization
                for i in 0..=j {
                    h[i][j] = Self::dot_product(&v[i], &w)?;
                    for l in 0..n {
                        let val = w.get(&[l])? - h[i][j] * v[i].get(&[l])?;
                        w.set(&[l], val)?;
                    }
                }

                h[j + 1][j] = Self::dot_product(&w, &w)?.sqrt();

                // Check for lucky breakdown
                if h[j + 1][j].abs() < T::from(1e-14).expect("1e-14 is representable as Float") {
                    k = j + 1;
                    break;
                }

                // Normalize
                for i in 0..n {
                    v[j + 1].set(&[i], w.get(&[i])? / h[j + 1][j])?;
                }

                // Apply previous Givens rotations to new column
                for i in 0..j {
                    let temp = h[i][j];
                    h[i][j] = cs_vec[i] * temp + sn_vec[i] * h[i + 1][j];
                    h[i + 1][j] = -sn_vec[i] * temp + cs_vec[i] * h[i + 1][j];
                }

                // Compute new Givens rotation
                let r_val = (h[j][j].powi(2) + h[j + 1][j].powi(2)).sqrt();
                if r_val < T::from(1e-14).expect("1e-14 is representable as Float") {
                    k = j + 1;
                    break;
                }

                let cs = h[j][j] / r_val;
                let sn = h[j + 1][j] / r_val;
                cs_vec[j] = cs;
                sn_vec[j] = sn;

                // Apply new rotation to H
                h[j][j] = r_val;
                h[j + 1][j] = T::zero();

                // Apply new rotation to g
                let temp_g = g[j];
                g[j] = cs * temp_g;
                g[j + 1] = -sn * temp_g;

                k = j + 1;

                // Check convergence
                if g[j + 1].abs() / b_norm < tol {
                    break;
                }
            }

            // Solve upper triangular system H*y = g
            let mut y = vec![T::zero(); k];
            for i in (0..k).rev() {
                let mut sum = g[i];
                for j in (i + 1)..k {
                    sum = sum - h[i][j] * y[j];
                }
                y[i] = sum / h[i][i];
            }

            // Update solution: x = x + V * y
            for j in 0..k {
                for i in 0..n {
                    let x_val = x.get(&[i])? + y[j] * v[j].get(&[i])?;
                    x.set(&[i], x_val)?;
                }
            }

            // Check final residual
            let mut ax_final = Array::zeros(&[n]);
            Self::spmv_dense(a, &x, &mut ax_final, T::one(), T::zero())?;

            let mut r_final = Array::zeros(&[n]);
            for i in 0..n {
                r_final.set(&[i], b.get(&[i])? - ax_final.get(&[i])?)?;
            }
            let final_r_norm = Self::dot_product(&r_final, &r_final)?.sqrt();

            if final_r_norm / b_norm < tol || total_iter >= max_iter {
                return Ok((x, total_iter, final_r_norm));
            }
        }

        // Compute final residual
        let mut ax = Array::zeros(&[n]);
        Self::spmv_dense(a, &x, &mut ax, T::one(), T::zero())?;

        let mut r = Array::zeros(&[n]);
        for i in 0..n {
            r.set(&[i], b.get(&[i])? - ax.get(&[i])?)?;
        }
        let final_residual = Self::dot_product(&r, &r)?.sqrt();

        Ok((x, max_iter, final_residual))
    }

    /// Incomplete LU decomposition for preconditioning
    pub fn incomplete_lu<T>(
        a: &SparseMatrix<T>,
        _fill_factor: f64,
    ) -> Result<(SparseMatrix<T>, SparseMatrix<T>)>
    where
        T: Float + Clone + Debug + Zero + One,
    {
        let n = a.shape()[0];

        if a.shape()[1] != n {
            return Err(NumRs2Error::DimensionMismatch(
                "Matrix must be square for ILU decomposition".to_string(),
            ));
        }

        // Create L and U matrices
        let mut l = SparseMatrix::new(&[n, n])?;
        let mut u = SparseMatrix::new(&[n, n])?;

        // Initialize L with identity on diagonal
        for i in 0..n {
            l.set(i, i, T::one())?;
        }

        // Copy upper triangular part to U, lower to L
        for (indices, value) in &a.array.data {
            let i = indices[0];
            let j = indices[1];

            if i <= j {
                u.set(i, j, *value)?;
            } else {
                l.set(i, j, *value)?;
            }
        }

        // Simplified ILU(0) - only process existing sparsity pattern
        for k in 0..n {
            let u_kk = u.get(k, k)?;
            if u_kk.abs() < T::epsilon() {
                return Err(NumRs2Error::ComputationError(
                    "ILU decomposition failed: zero pivot".to_string(),
                ));
            }

            // Process elements below diagonal in column k
            for i in (k + 1)..n {
                let l_ik = l.get(i, k)?;
                if l_ik != T::zero() {
                    let factor = l_ik / u_kk;
                    l.set(i, k, factor)?;

                    // Update row i of U
                    for j in (k + 1)..n {
                        let u_kj = u.get(k, j)?;
                        if u_kj != T::zero() {
                            let u_ij = u.get(i, j)?;
                            u.set(i, j, u_ij - factor * u_kj)?;
                        }
                    }
                }
            }
        }

        Ok((l, u))
    }

    /// Helper function to compute dot product of two arrays
    fn dot_product<T>(x: &Array<T>, y: &Array<T>) -> Result<T>
    where
        T: Float + Clone + Debug,
    {
        if x.shape() != y.shape() {
            return Err(NumRs2Error::DimensionMismatch(
                "Arrays must have same shape for dot product".to_string(),
            ));
        }

        let n = x.shape()[0];
        let mut result = T::zero();

        for i in 0..n {
            let x_val = x.get(&[i])?;
            let y_val = y.get(&[i])?;
            result = result + x_val * y_val;
        }

        Ok(result)
    }

    /// Estimate the condition number of a sparse matrix using power iteration
    pub fn condition_number_estimate<T>(a: &SparseMatrix<T>, max_iter: usize, tol: T) -> Result<T>
    where
        T: Float + Clone + Debug,
    {
        let n = a.shape()[0];

        if a.shape()[1] != n {
            return Err(NumRs2Error::DimensionMismatch(
                "Matrix must be square for condition number estimation".to_string(),
            ));
        }

        // Estimate largest eigenvalue using power iteration
        let mut v = Array::ones(&[n]);
        let mut lambda_max = T::zero();

        for _ in 0..max_iter {
            let mut av = Array::zeros(&[n]);
            Self::spmv_dense(a, &v, &mut av, T::one(), T::zero())?;

            let norm = Self::vector_norm(&av)?;
            if norm < T::epsilon() {
                return Err(NumRs2Error::ComputationError(
                    "Power iteration failed: zero norm".to_string(),
                ));
            }

            // Normalize
            for i in 0..n {
                let val = av.get(&[i])?;
                v.set(&[i], val / norm)?;
            }

            let new_lambda = Self::dot_product(&v, &av)?;

            if (new_lambda - lambda_max).abs() < tol {
                lambda_max = new_lambda;
                break;
            }
            lambda_max = new_lambda;
        }

        // For condition number, we would need smallest eigenvalue too
        // For now, return an estimate based on largest eigenvalue
        // This is a simplified implementation - full condition number estimation
        // would require more sophisticated algorithms
        Ok(lambda_max.abs())
    }

    /// Compute the 2-norm of a vector
    fn vector_norm<T>(x: &Array<T>) -> Result<T>
    where
        T: Float + Clone + Debug,
    {
        let n = x.shape()[0];
        let mut sum = T::zero();

        for i in 0..n {
            let val = x.get(&[i])?;
            sum = sum + val * val;
        }

        Ok(sum.sqrt())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::sparse::SparseMatrix;
    use approx::assert_relative_eq;

    #[test]
    fn test_sparse_matrix_vector_multiplication() {
        // Create a sparse matrix
        let mut a = SparseMatrix::new(&[3, 3]).expect("3x3 sparse matrix creation");
        a.set(0, 0, 2.0).expect("set matrix element");
        a.set(0, 1, 1.0).expect("set matrix element");
        a.set(1, 1, 3.0).expect("set matrix element");
        a.set(2, 2, 4.0).expect("set matrix element");

        // Create input vector
        let x = Array::from_vec(vec![1.0, 2.0, 3.0]);
        let mut y = Array::zeros(&[3]);

        // Test sparse matrix-vector multiplication
        SparseOpsAdvanced::spmv_dense(&a, &x, &mut y, 1.0, 0.0).expect("spmv_dense");

        // Expected: [2*1 + 1*2, 3*2, 4*3] = [4, 6, 12]
        assert_relative_eq!(y.get(&[0]).expect("get y[0]"), 4.0, epsilon = 1e-10);
        assert_relative_eq!(y.get(&[1]).expect("get y[1]"), 6.0, epsilon = 1e-10);
        assert_relative_eq!(y.get(&[2]).expect("get y[2]"), 12.0, epsilon = 1e-10);
    }

    #[test]
    fn test_conjugate_gradient_solver() {
        // Create a symmetric positive definite matrix
        let mut a = SparseMatrix::new(&[3, 3]).expect("3x3 sparse matrix creation");
        a.set(0, 0, 4.0).expect("set matrix element");
        a.set(0, 1, 1.0).expect("set matrix element");
        a.set(1, 0, 1.0).expect("set matrix element");
        a.set(1, 1, 3.0).expect("set matrix element");
        a.set(1, 2, 1.0).expect("set matrix element");
        a.set(2, 1, 1.0).expect("set matrix element");
        a.set(2, 2, 2.0).expect("set matrix element");

        // Right-hand side
        let b = Array::from_vec(vec![6.0, 8.0, 4.0]);

        // Solve using CG
        let (x, iter, residual) =
            SparseOpsAdvanced::solve_cg(&a, &b, None, 1e-10, 100).expect("CG solver");

        // Check that the solution satisfies A*x = b (approximately)
        let mut ax = Array::zeros(&[3]);
        SparseOpsAdvanced::spmv_dense(&a, &x, &mut ax, 1.0, 0.0).expect("spmv_dense");

        for i in 0..3 {
            let b_val = b.get(&[i]).expect("get b[i]");
            let ax_val = ax.get(&[i]).expect("get ax[i]");
            assert_relative_eq!(ax_val, b_val, epsilon = 1e-8);
        }

        assert!(iter < 100);
        assert!(residual < 1e-8);
    }

    #[test]
    fn test_bicgstab_solver() {
        // Create a general matrix
        let mut a = SparseMatrix::new(&[3, 3]).expect("3x3 sparse matrix creation");
        a.set(0, 0, 3.0).expect("set matrix element");
        a.set(0, 1, 1.0).expect("set matrix element");
        a.set(1, 0, 1.0).expect("set matrix element");
        a.set(1, 1, 2.0).expect("set matrix element");
        a.set(1, 2, 1.0).expect("set matrix element");
        a.set(2, 1, 1.0).expect("set matrix element");
        a.set(2, 2, 3.0).expect("set matrix element");

        // Right-hand side
        let b = Array::from_vec(vec![5.0, 6.0, 7.0]);

        // Solve using BiCGSTAB
        let (x, iter, residual) =
            SparseOpsAdvanced::solve_bicgstab(&a, &b, None, 1e-10, 100).expect("BiCGSTAB solver");

        // Check that the solution satisfies A*x = b (approximately)
        let mut ax = Array::zeros(&[3]);
        SparseOpsAdvanced::spmv_dense(&a, &x, &mut ax, 1.0, 0.0).expect("spmv_dense");

        for i in 0..3 {
            let b_val = b.get(&[i]).expect("get b[i]");
            let ax_val = ax.get(&[i]).expect("get ax[i]");
            assert_relative_eq!(ax_val, b_val, epsilon = 1e-8);
        }

        assert!(iter < 100);
        assert!(residual < 1e-8);
    }

    #[test]
    fn test_gmres_solver() {
        // Create a general matrix (non-symmetric)
        let mut a = SparseMatrix::new(&[3, 3]).expect("3x3 sparse matrix creation");
        a.set(0, 0, 3.0).expect("set matrix element");
        a.set(0, 1, 1.0).expect("set matrix element");
        a.set(0, 2, 0.5).expect("set matrix element");
        a.set(1, 0, 1.0).expect("set matrix element");
        a.set(1, 1, 4.0).expect("set matrix element");
        a.set(1, 2, 1.0).expect("set matrix element");
        a.set(2, 0, 0.0).expect("set matrix element");
        a.set(2, 1, 2.0).expect("set matrix element");
        a.set(2, 2, 5.0).expect("set matrix element");

        // Right-hand side
        let b = Array::from_vec(vec![5.5, 9.0, 17.0]);

        // Solve using GMRES
        let (x, iter, residual) =
            SparseOpsAdvanced::solve_gmres(&a, &b, None, 1e-10, 100, 30).expect("GMRES solver");

        // Check that the solution satisfies A*x = b (approximately)
        let mut ax = Array::zeros(&[3]);
        SparseOpsAdvanced::spmv_dense(&a, &x, &mut ax, 1.0, 0.0).expect("spmv_dense");

        for i in 0..3 {
            let b_val = b.get(&[i]).expect("get b[i]");
            let ax_val = ax.get(&[i]).expect("get ax[i]");
            assert_relative_eq!(ax_val, b_val, epsilon = 1e-8);
        }

        assert!(iter < 100);
        assert!(residual < 1e-8);
    }

    #[test]
    fn test_gmres_solver_larger_system() {
        // Create a larger sparse matrix (5x5 diagonally dominant)
        let n = 5;
        let mut a = SparseMatrix::new(&[n, n]).expect("nxn sparse matrix creation");

        // Tridiagonal matrix with strong diagonal dominance
        for i in 0..n {
            a.set(i, i, 4.0).expect("set diagonal element"); // Main diagonal
            if i > 0 {
                a.set(i, i - 1, -1.0).expect("set lower diagonal"); // Lower diagonal
            }
            if i < n - 1 {
                a.set(i, i + 1, -1.0).expect("set upper diagonal"); // Upper diagonal
            }
        }

        // Right-hand side: solution should be [1, 2, 3, 4, 5]
        let b = Array::from_vec(vec![2.0, 1.0, 2.0, 3.0, 16.0]);

        // Solve using GMRES
        let (x, iter, residual) =
            SparseOpsAdvanced::solve_gmres(&a, &b, None, 1e-10, 100, 30).expect("GMRES solver");

        // Check that the solution satisfies A*x = b
        let mut ax = Array::zeros(&[n]);
        SparseOpsAdvanced::spmv_dense(&a, &x, &mut ax, 1.0, 0.0).expect("spmv_dense");

        for i in 0..n {
            let b_val = b.get(&[i]).expect("get b[i]");
            let ax_val = ax.get(&[i]).expect("get ax[i]");
            assert_relative_eq!(ax_val, b_val, epsilon = 1e-8);
        }

        assert!(iter < 100);
        assert!(residual < 1e-8);
    }

    #[test]
    fn test_gmres_with_restart() {
        // Create a matrix that might need restart
        let n = 4;
        let mut a = SparseMatrix::new(&[n, n]).expect("nxn sparse matrix creation");

        // Create a diagonally dominant matrix
        for i in 0..n {
            a.set(i, i, 5.0).expect("set diagonal element");
            for j in 0..n {
                if i != j {
                    a.set(i, j, 0.5).expect("set off-diagonal element");
                }
            }
        }

        let b = Array::from_vec(vec![7.5, 7.5, 7.5, 7.5]);

        // Solve with small restart parameter to force restarts
        let (x, _iter, residual) = SparseOpsAdvanced::solve_gmres(&a, &b, None, 1e-10, 100, 2)
            .expect("GMRES solver with restart");

        // Verify solution
        let mut ax = Array::zeros(&[n]);
        SparseOpsAdvanced::spmv_dense(&a, &x, &mut ax, 1.0, 0.0).expect("spmv_dense");

        for i in 0..n {
            let b_val = b.get(&[i]).expect("get b[i]");
            let ax_val = ax.get(&[i]).expect("get ax[i]");
            assert_relative_eq!(ax_val, b_val, epsilon = 1e-6);
        }

        assert!(residual < 1e-6);
    }

    #[test]
    fn test_gmres_vs_bicgstab() {
        // Compare GMRES and BiCGSTAB on the same problem
        let mut a = SparseMatrix::new(&[3, 3]).expect("3x3 sparse matrix creation");
        a.set(0, 0, 4.0).expect("set matrix element");
        a.set(0, 1, 1.0).expect("set matrix element");
        a.set(1, 0, 2.0).expect("set matrix element");
        a.set(1, 1, 3.0).expect("set matrix element");
        a.set(1, 2, 1.0).expect("set matrix element");
        a.set(2, 1, 1.0).expect("set matrix element");
        a.set(2, 2, 4.0).expect("set matrix element");

        let b = Array::from_vec(vec![6.0, 9.0, 5.0]);

        // Solve with GMRES
        let (x_gmres, _, residual_gmres) =
            SparseOpsAdvanced::solve_gmres(&a, &b, None, 1e-10, 100, 30).expect("GMRES solver");

        // Solve with BiCGSTAB
        let (x_bicgstab, _, residual_bicgstab) =
            SparseOpsAdvanced::solve_bicgstab(&a, &b, None, 1e-10, 100).expect("BiCGSTAB solver");

        // Both should converge
        assert!(residual_gmres < 1e-8);
        assert!(residual_bicgstab < 1e-8);

        // Solutions should be similar
        for i in 0..3 {
            let g_val = x_gmres.get(&[i]).expect("get x_gmres[i]");
            let b_val = x_bicgstab.get(&[i]).expect("get b[i]");
            assert_relative_eq!(g_val, b_val, epsilon = 1e-6);
        }
    }

    #[test]
    fn test_incomplete_lu_decomposition() {
        // Create a test matrix
        let mut a = SparseMatrix::new(&[3, 3]).expect("3x3 sparse matrix creation");
        a.set(0, 0, 4.0).expect("set matrix element");
        a.set(0, 1, 1.0).expect("set matrix element");
        a.set(1, 0, 1.0).expect("set matrix element");
        a.set(1, 1, 3.0).expect("set matrix element");
        a.set(1, 2, 1.0).expect("set matrix element");
        a.set(2, 1, 1.0).expect("set matrix element");
        a.set(2, 2, 2.0).expect("set matrix element");

        // Compute ILU decomposition
        let (l, u) = SparseOpsAdvanced::incomplete_lu(&a, 1.0).expect("ILU decomposition");

        // Verify that L is lower triangular with 1s on diagonal
        assert_relative_eq!(l.get(0, 0).expect("get L[0,0]"), 1.0, epsilon = 1e-10);
        assert_relative_eq!(l.get(1, 1).expect("get L[1,1]"), 1.0, epsilon = 1e-10);
        assert_relative_eq!(l.get(2, 2).expect("get L[2,2]"), 1.0, epsilon = 1e-10);
        assert_relative_eq!(l.get(0, 1).expect("get L[0,1]"), 0.0, epsilon = 1e-10);
        assert_relative_eq!(l.get(0, 2).expect("get L[0,2]"), 0.0, epsilon = 1e-10);

        // Verify U is upper triangular
        assert_relative_eq!(u.get(1, 0).expect("get U[1,0]"), 0.0, epsilon = 1e-10);
        assert_relative_eq!(u.get(2, 0).expect("get U[2,0]"), 0.0, epsilon = 1e-10);
        assert_relative_eq!(u.get(2, 1).expect("get U[2,1]"), 0.0, epsilon = 1e-10);
    }
}