scirs2-fft 0.4.0

Fast Fourier Transform module for SciRS2 (scirs2-fft)
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
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
/*!
 * FFT algorithm implementations
 *
 * This module provides implementations of the Fast Fourier Transform (FFT)
 * and its inverse (IFFT) in 1D, 2D, and N-dimensional cases.
 */

use crate::error::{FFTError, FFTResult};
#[cfg(feature = "oxifft")]
use crate::oxifft_plan_cache;
#[cfg(feature = "oxifft")]
use oxifft::{Complex as OxiComplex, Direction};
#[cfg(feature = "rustfft-backend")]
use rustfft::{num_complex::Complex as RustComplex, FftPlanner};
use scirs2_core::ndarray::{Array2, ArrayD, Axis, IxDyn};
use scirs2_core::numeric::Complex64;
use scirs2_core::numeric::NumCast;
use scirs2_core::safe_ops::{safe_divide, safe_sqrt};
use std::fmt::Debug;

// We're using the serial implementation even with parallel feature enabled,
// since we're not using parallelism at this level

/// Normalization mode for FFT operations
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum NormMode {
    /// No normalization (default for forward transforms)
    None,
    /// Normalize by 1/n (default for inverse transforms)
    Backward,
    /// Normalize by 1/sqrt(n) (unitary transform)
    Ortho,
    /// Normalize by 1/n for both forward and inverse transforms
    Forward,
}

impl From<&str> for NormMode {
    fn from(s: &str) -> Self {
        match s {
            "backward" => NormMode::Backward,
            "ortho" => NormMode::Ortho,
            "forward" => NormMode::Forward,
            _ => NormMode::None,
        }
    }
}

/// Convert a normalization mode string to NormMode enum
#[allow(dead_code)]
pub fn parse_norm_mode(_norm: Option<&str>, isinverse: bool) -> NormMode {
    match _norm {
        Some(s) => NormMode::from(s),
        None if isinverse => NormMode::Backward, // Default for _inverse transforms
        None => NormMode::None,                  // Default for forward transforms
    }
}

/// Apply normalization to FFT results based on the specified mode
#[allow(dead_code)]
fn apply_normalization(data: &mut [Complex64], n: usize, mode: NormMode) -> FFTResult<()> {
    match mode {
        NormMode::None => {} // No normalization
        NormMode::Backward => {
            let n_f64 = n as f64;
            let scale = safe_divide(1.0, n_f64).map_err(|_| {
                FFTError::ValueError(
                    "Division by zero in backward normalization: FFT size is zero".to_string(),
                )
            })?;
            data.iter_mut().for_each(|c| *c *= scale);
        }
        NormMode::Ortho => {
            let n_f64 = n as f64;
            let sqrt_n = safe_sqrt(n_f64).map_err(|_| {
                FFTError::ComputationError(
                    "Invalid square root in orthogonal normalization".to_string(),
                )
            })?;
            let scale = safe_divide(1.0, sqrt_n).map_err(|_| {
                FFTError::ValueError("Division by zero in orthogonal normalization".to_string())
            })?;
            data.iter_mut().for_each(|c| *c *= scale);
        }
        NormMode::Forward => {
            let n_f64 = n as f64;
            let scale = safe_divide(1.0, n_f64).map_err(|_| {
                FFTError::ValueError(
                    "Division by zero in forward normalization: FFT size is zero".to_string(),
                )
            })?;
            data.iter_mut().for_each(|c| *c *= scale);
        }
    }
    Ok(())
}

/// Convert a single value to Complex64
#[allow(dead_code)]
fn convert_to_complex<T>(val: T) -> FFTResult<Complex64>
where
    T: NumCast + Copy + Debug + 'static,
{
    // First try to cast directly to f64 (for real numbers)
    if let Some(real) = NumCast::from(val) {
        return Ok(Complex64::new(real, 0.0));
    }

    // If direct casting fails, check if it's already a Complex64
    use std::any::Any;
    if let Some(complex) = (&val as &dyn Any).downcast_ref::<Complex64>() {
        return Ok(*complex);
    }

    // Try to handle f32 complex numbers
    if let Some(complex32) = (&val as &dyn Any).downcast_ref::<scirs2_core::numeric::Complex<f32>>()
    {
        return Ok(Complex64::new(complex32.re as f64, complex32.im as f64));
    }

    Err(FFTError::ValueError(format!(
        "Could not convert {val:?} to numeric type"
    )))
}

/// Convert input data to complex values
#[allow(dead_code)]
fn to_complex<T>(input: &[T]) -> FFTResult<Vec<Complex64>>
where
    T: NumCast + Copy + Debug + 'static,
{
    input.iter().map(|&val| convert_to_complex(val)).collect()
}

/// Compute the 1-dimensional Fast Fourier Transform
///
/// # Arguments
///
/// * `input` - Input data array
/// * `n` - Length of the output (optional)
///
/// # Returns
///
/// A vector of complex values representing the FFT result
///
/// # Examples
///
/// ```
/// use scirs2_fft::fft;
/// use scirs2_core::numeric::Complex64;
///
/// // Generate a simple signal
/// let signal = vec![1.0, 2.0, 3.0, 4.0];
///
/// // Compute the FFT
/// let spectrum = fft(&signal, None).expect("valid input");
///
/// // The DC component should be the sum of the input
/// assert!((spectrum[0].re - 10.0).abs() < 1e-10);
/// assert!(spectrum[0].im.abs() < 1e-10);
/// ```
#[allow(dead_code)]
pub fn fft<T>(input: &[T], n: Option<usize>) -> FFTResult<Vec<Complex64>>
where
    T: NumCast + Copy + Debug + 'static,
{
    // Input validation
    if input.is_empty() {
        return Err(FFTError::ValueError("Input cannot be empty".to_string()));
    }

    // Determine the FFT size (n or next power of 2 if n is None)
    let input_len = input.len();
    let fft_size = n.unwrap_or_else(|| input_len.next_power_of_two());

    // Convert _input to complex numbers
    let mut data = to_complex(input)?;

    // Pad or truncate data to match fft_size
    if fft_size != input_len {
        if fft_size > input_len {
            // Pad with zeros
            data.resize(fft_size, Complex64::new(0.0, 0.0));
        } else {
            // Truncate
            data.truncate(fft_size);
        }
    }

    // Use FFT library for computation
    #[cfg(feature = "oxifft")]
    {
        // Convert to OxiFFT-compatible complex type
        let input_oxi: Vec<OxiComplex<f64>> =
            data.iter().map(|c| OxiComplex::new(c.re, c.im)).collect();
        let mut output: Vec<OxiComplex<f64>> = vec![OxiComplex::zero(); fft_size];

        // Execute FFT with cached plan
        oxifft_plan_cache::execute_c2c(&input_oxi, &mut output, Direction::Forward)?;

        // Convert back to our Complex64 type
        let result: Vec<Complex64> = output
            .into_iter()
            .map(|c| Complex64::new(c.re, c.im))
            .collect();

        Ok(result)
    }

    #[cfg(not(feature = "oxifft"))]
    {
        #[cfg(feature = "rustfft-backend")]
        {
            let mut planner = FftPlanner::new();
            let fft_plan = planner.plan_fft_forward(fft_size);

            // Convert to rustfft-compatible complex type
            let mut buffer: Vec<RustComplex<f64>> =
                data.iter().map(|c| RustComplex::new(c.re, c.im)).collect();

            // Perform FFT in-place
            fft_plan.process(&mut buffer);

            // Convert back to our Complex64 type
            let result: Vec<Complex64> = buffer
                .into_iter()
                .map(|c| Complex64::new(c.re, c.im))
                .collect();

            Ok(result)
        }

        #[cfg(not(feature = "rustfft-backend"))]
        {
            Err(FFTError::ComputationError(
                "No FFT backend available. Enable either 'oxifft' or 'rustfft-backend' feature."
                    .to_string(),
            ))
        }
    }
}

/// Compute the inverse 1-dimensional Fast Fourier Transform
///
/// # Arguments
///
/// * `input` - Input data array
/// * `n` - Length of the output (optional)
///
/// # Returns
///
/// A vector of complex values representing the inverse FFT result
///
/// # Examples
///
/// ```
/// use scirs2_fft::{fft, ifft};
/// use scirs2_core::numeric::Complex64;
///
/// // Generate a simple signal
/// let signal = vec![1.0, 2.0, 3.0, 4.0];
///
/// // Compute the FFT
/// let spectrum = fft(&signal, None).expect("valid input");
///
/// // Compute the inverse FFT
/// let reconstructed = ifft(&spectrum, None).expect("valid input");
///
/// // The reconstructed signal should match the original
/// for (i, val) in signal.iter().enumerate() {
///     assert!((*val - reconstructed[i].re).abs() < 1e-10);
///     assert!(reconstructed[i].im.abs() < 1e-10);
/// }
/// ```
#[allow(dead_code)]
#[allow(unreachable_code)]
pub fn ifft<T>(input: &[T], n: Option<usize>) -> FFTResult<Vec<Complex64>>
where
    T: NumCast + Copy + Debug + 'static,
{
    // Input validation
    if input.is_empty() {
        return Err(FFTError::ValueError("Input cannot be empty".to_string()));
    }

    // Determine the FFT size
    let input_len = input.len();
    let fft_size = n.unwrap_or_else(|| input_len.next_power_of_two());

    // Convert _input to complex numbers
    let mut data = to_complex(input)?;

    // Pad or truncate data to match fft_size
    if fft_size != input_len {
        if fft_size > input_len {
            // Pad with zeros
            data.resize(fft_size, Complex64::new(0.0, 0.0));
        } else {
            // Truncate
            data.truncate(fft_size);
        }
    }

    // Guard: no backend available
    #[cfg(all(not(feature = "oxifft"), not(feature = "rustfft-backend")))]
    return Err(FFTError::ComputationError(
        "No FFT backend available. Enable either 'oxifft' or 'rustfft-backend' feature."
            .to_string(),
    ));

    // Create FFT planner and plan
    #[cfg(feature = "oxifft")]
    let mut result = {
        // Convert to OxiFFT-compatible complex type
        let input_oxi: Vec<OxiComplex<f64>> =
            data.iter().map(|c| OxiComplex::new(c.re, c.im)).collect();
        let mut output: Vec<OxiComplex<f64>> = vec![OxiComplex::zero(); fft_size];

        // Execute IFFT with cached plan
        oxifft_plan_cache::execute_c2c(&input_oxi, &mut output, Direction::Backward)?;

        // Convert back to our Complex64 type
        let mut result: Vec<Complex64> = output
            .into_iter()
            .map(|c| Complex64::new(c.re, c.im))
            .collect();

        // Apply 1/N normalization (standard for IFFT)
        apply_normalization(&mut result, fft_size, NormMode::Backward)?;

        result
    };

    #[cfg(all(not(feature = "oxifft"), feature = "rustfft-backend"))]
    let mut result: Vec<Complex64> = {
        let mut planner = FftPlanner::new();
        let ifft_plan = planner.plan_fft_inverse(fft_size);

        // Convert to rustfft-compatible complex type
        let mut buffer: Vec<RustComplex<f64>> =
            data.iter().map(|c| RustComplex::new(c.re, c.im)).collect();

        // Perform inverse FFT in-place
        ifft_plan.process(&mut buffer);

        // Convert back to our Complex64 type with normalization
        let mut result: Vec<Complex64> = buffer
            .into_iter()
            .map(|c| Complex64::new(c.re, c.im))
            .collect();

        // Apply 1/N normalization (standard for IFFT)
        apply_normalization(&mut result, fft_size, NormMode::Backward)?;

        result
    };

    // Truncate if necessary to match the original _input length
    #[cfg(any(feature = "oxifft", feature = "rustfft-backend"))]
    {
        if n.is_none() && fft_size > input_len {
            result.truncate(input_len);
        }

        Ok(result)
    }
    #[cfg(all(not(feature = "oxifft"), not(feature = "rustfft-backend")))]
    unreachable!()
}

/// Compute the 2-dimensional Fast Fourier Transform
///
/// # Arguments
///
/// * `input` - Input 2D array
/// * `shape` - Shape of the output (optional)
/// * `axes` - Axes along which to compute the FFT (optional)
/// * `norm` - Normalization mode: "backward", "ortho", or "forward" (optional)
///
/// # Returns
///
/// A 2D array of complex values representing the FFT result
///
/// # Examples
///
/// ```
/// use scirs2_fft::fft2;
/// use scirs2_core::ndarray::{array, Array2};
///
/// // Create a simple 2x2 array
/// let input = array![[1.0, 2.0], [3.0, 4.0]];
///
/// // Compute the 2D FFT
/// let result = fft2(&input, None, None, None).expect("valid input");
///
/// // The DC component should be the sum of all elements
/// assert!((result[[0, 0]].re - 10.0).abs() < 1e-10);
/// ```
#[allow(dead_code)]
#[allow(unreachable_code)]
pub fn fft2<T>(
    input: &Array2<T>,
    shape: Option<(usize, usize)>,
    axes: Option<(i32, i32)>,
    norm: Option<&str>,
) -> FFTResult<Array2<Complex64>>
where
    T: NumCast + Copy + Debug + 'static,
{
    // Get input array shape
    // Guard: no backend available
    #[cfg(all(not(feature = "oxifft"), not(feature = "rustfft-backend")))]
    return Err(FFTError::ComputationError(
        "No FFT backend available. Enable either 'oxifft' or 'rustfft-backend' feature."
            .to_string(),
    ));

    let inputshape = input.shape();

    // Determine output shape
    let outputshape = shape.unwrap_or((inputshape[0], inputshape[1]));

    // Determine axes to perform FFT on
    let axes = axes.unwrap_or((0, 1));

    // Validate axes
    if axes.0 < 0 || axes.0 > 1 || axes.1 < 0 || axes.1 > 1 || axes.0 == axes.1 {
        return Err(FFTError::ValueError("Invalid axes for 2D FFT".to_string()));
    }

    // Parse normalization mode
    let norm_mode = parse_norm_mode(norm, false);

    // Create the output array
    let mut output = Array2::<Complex64>::zeros(outputshape);

    // Convert input array to complex numbers
    let mut complex_input = Array2::<Complex64>::zeros((inputshape[0], inputshape[1]));
    for i in 0..inputshape[0] {
        for j in 0..inputshape[1] {
            let val = input[[i, j]];

            // Convert using the unified conversion function
            complex_input[[i, j]] = convert_to_complex(val)?;
        }
    }

    // Pad or truncate to match output shape if necessary
    let mut padded_input = if inputshape != [outputshape.0, outputshape.1] {
        let mut padded = Array2::<Complex64>::zeros((outputshape.0, outputshape.1));
        let copy_rows = std::cmp::min(inputshape[0], outputshape.0);
        let copy_cols = std::cmp::min(inputshape[1], outputshape.1);

        for i in 0..copy_rows {
            for j in 0..copy_cols {
                padded[[i, j]] = complex_input[[i, j]];
            }
        }
        padded
    } else {
        complex_input
    };

    // Perform FFT along rows and columns
    #[cfg(feature = "oxifft")]
    {
        // Perform FFT along each row
        for mut row in padded_input.rows_mut() {
            // Convert to OxiFFT compatible format
            let input_oxi: Vec<OxiComplex<f64>> =
                row.iter().map(|&c| OxiComplex::new(c.re, c.im)).collect();
            let mut output: Vec<OxiComplex<f64>> = vec![OxiComplex::zero(); outputshape.1];

            // Perform FFT
            oxifft_plan_cache::execute_c2c(&input_oxi, &mut output, Direction::Forward)?;

            // Update row with FFT result
            for (i, val) in output.iter().enumerate() {
                row[i] = Complex64::new(val.re, val.im);
            }
        }

        // Perform FFT along each column
        for mut col in padded_input.columns_mut() {
            // Convert to OxiFFT compatible format
            let input_oxi: Vec<OxiComplex<f64>> =
                col.iter().map(|&c| OxiComplex::new(c.re, c.im)).collect();
            let mut output: Vec<OxiComplex<f64>> = vec![OxiComplex::zero(); outputshape.0];

            // Perform FFT
            oxifft_plan_cache::execute_c2c(&input_oxi, &mut output, Direction::Forward)?;

            // Update column with FFT result
            for (i, val) in output.iter().enumerate() {
                col[i] = Complex64::new(val.re, val.im);
            }
        }
    }

    #[cfg(all(not(feature = "oxifft"), feature = "rustfft-backend"))]
    {
        // Create FFT planner
        let mut planner = FftPlanner::new();

        // Perform FFT along each row
        let row_fft = planner.plan_fft_forward(outputshape.1);
        for mut row in padded_input.rows_mut() {
            // Convert to rustfft compatible format
            let mut buffer: Vec<RustComplex<f64>> =
                row.iter().map(|&c| RustComplex::new(c.re, c.im)).collect();

            // Perform FFT
            row_fft.process(&mut buffer);

            // Update row with FFT result
            for (i, val) in buffer.iter().enumerate() {
                row[i] = Complex64::new(val.re, val.im);
            }
        }

        // Perform FFT along each column
        let col_fft = planner.plan_fft_forward(outputshape.0);
        for mut col in padded_input.columns_mut() {
            // Convert to rustfft compatible format
            let mut buffer: Vec<RustComplex<f64>> =
                col.iter().map(|&c| RustComplex::new(c.re, c.im)).collect();

            // Perform FFT
            col_fft.process(&mut buffer);

            // Update column with FFT result
            for (i, val) in buffer.iter().enumerate() {
                col[i] = Complex64::new(val.re, val.im);
            }
        }
    }

    // Apply normalization if needed
    if norm_mode != NormMode::None {
        let total_elements = outputshape.0 * outputshape.1;
        let scale = match norm_mode {
            NormMode::Backward => 1.0 / (total_elements as f64),
            NormMode::Ortho => 1.0 / (total_elements as f64).sqrt(),
            NormMode::Forward => 1.0 / (total_elements as f64),
            NormMode::None => 1.0, // Should not happen due to earlier check
        };

        padded_input.mapv_inplace(|x| x * scale);
    }

    // Copy result to output
    output.assign(&padded_input);

    Ok(output)
}

/// Compute the inverse 2-dimensional Fast Fourier Transform
///
/// # Arguments
///
/// * `input` - Input 2D array
/// * `shape` - Shape of the output (optional)
/// * `axes` - Axes along which to compute the inverse FFT (optional)
/// * `norm` - Normalization mode: "backward", "ortho", or "forward" (optional)
///
/// # Returns
///
/// A 2D array of complex values representing the inverse FFT result
///
/// # Examples
///
/// ```
/// use scirs2_fft::{fft2, ifft2};
/// use scirs2_core::ndarray::{array, Array2};
///
/// // Create a simple 2x2 array
/// let input = array![[1.0, 2.0], [3.0, 4.0]];
///
/// // Compute the 2D FFT
/// let spectrum = fft2(&input, None, None, None).expect("valid input");
///
/// // Compute the inverse 2D FFT
/// let reconstructed = ifft2(&spectrum, None, None, None).expect("valid input");
///
/// // The reconstructed signal should match the original
/// for i in 0..2 {
///     for j in 0..2 {
///         assert!((input[[i, j]] - reconstructed[[i, j]].re).abs() < 1e-10);
///         assert!(reconstructed[[i, j]].im.abs() < 1e-10);
///     }
/// }
/// ```
#[allow(dead_code)]
#[allow(unreachable_code)]
pub fn ifft2<T>(
    input: &Array2<T>,
    shape: Option<(usize, usize)>,
    axes: Option<(i32, i32)>,
    norm: Option<&str>,
) -> FFTResult<Array2<Complex64>>
where
    T: NumCast + Copy + Debug + 'static,
{
    // Guard: no backend available
    #[cfg(all(not(feature = "oxifft"), not(feature = "rustfft-backend")))]
    return Err(FFTError::ComputationError(
        "No FFT backend available. Enable either 'oxifft' or 'rustfft-backend' feature."
            .to_string(),
    ));

    // Get input array shape
    let inputshape = input.shape();

    // Determine output shape
    let outputshape = shape.unwrap_or((inputshape[0], inputshape[1]));

    // Determine axes to perform FFT on
    let axes = axes.unwrap_or((0, 1));

    // Validate axes
    if axes.0 < 0 || axes.0 > 1 || axes.1 < 0 || axes.1 > 1 || axes.0 == axes.1 {
        return Err(FFTError::ValueError("Invalid axes for 2D IFFT".to_string()));
    }

    // Parse normalization mode (default is "backward" for inverse FFT)
    let norm_mode = parse_norm_mode(norm, true);

    // Convert input to complex and copy to output shape
    let mut complex_input = Array2::<Complex64>::zeros((inputshape[0], inputshape[1]));
    for i in 0..inputshape[0] {
        for j in 0..inputshape[1] {
            let val = input[[i, j]];

            // Convert using the unified conversion function
            complex_input[[i, j]] = convert_to_complex(val)?;
        }
    }

    // Pad or truncate to match output shape if necessary
    let mut padded_input = if inputshape != [outputshape.0, outputshape.1] {
        let mut padded = Array2::<Complex64>::zeros((outputshape.0, outputshape.1));
        let copy_rows = std::cmp::min(inputshape[0], outputshape.0);
        let copy_cols = std::cmp::min(inputshape[1], outputshape.1);

        for i in 0..copy_rows {
            for j in 0..copy_cols {
                padded[[i, j]] = complex_input[[i, j]];
            }
        }
        padded
    } else {
        complex_input
    };

    // Perform inverse FFT along rows and columns
    #[cfg(feature = "oxifft")]
    {
        // Perform inverse FFT along each row
        for mut row in padded_input.rows_mut() {
            // Convert to OxiFFT compatible format
            let input_oxi: Vec<OxiComplex<f64>> =
                row.iter().map(|&c| OxiComplex::new(c.re, c.im)).collect();
            let mut output: Vec<OxiComplex<f64>> = vec![OxiComplex::zero(); outputshape.1];

            // Perform inverse FFT
            oxifft_plan_cache::execute_c2c(&input_oxi, &mut output, Direction::Backward)?;

            // Update row with IFFT result
            for (i, val) in output.iter().enumerate() {
                row[i] = Complex64::new(val.re, val.im);
            }
        }

        // Perform inverse FFT along each column
        for mut col in padded_input.columns_mut() {
            // Convert to OxiFFT compatible format
            let input_oxi: Vec<OxiComplex<f64>> =
                col.iter().map(|&c| OxiComplex::new(c.re, c.im)).collect();
            let mut output: Vec<OxiComplex<f64>> = vec![OxiComplex::zero(); outputshape.0];

            // Perform inverse FFT
            oxifft_plan_cache::execute_c2c(&input_oxi, &mut output, Direction::Backward)?;

            // Update column with IFFT result
            for (i, val) in output.iter().enumerate() {
                col[i] = Complex64::new(val.re, val.im);
            }
        }
    }

    #[cfg(all(not(feature = "oxifft"), feature = "rustfft-backend"))]
    {
        // Create FFT planner
        let mut planner = FftPlanner::new();

        // Perform inverse FFT along each row
        let row_ifft = planner.plan_fft_inverse(outputshape.1);
        for mut row in padded_input.rows_mut() {
            // Convert to rustfft compatible format
            let mut buffer: Vec<RustComplex<f64>> =
                row.iter().map(|&c| RustComplex::new(c.re, c.im)).collect();

            // Perform inverse FFT
            row_ifft.process(&mut buffer);

            // Update row with IFFT result
            for (i, val) in buffer.iter().enumerate() {
                row[i] = Complex64::new(val.re, val.im);
            }
        }

        // Perform inverse FFT along each column
        let col_ifft = planner.plan_fft_inverse(outputshape.0);
        for mut col in padded_input.columns_mut() {
            // Convert to rustfft compatible format
            let mut buffer: Vec<RustComplex<f64>> =
                col.iter().map(|&c| RustComplex::new(c.re, c.im)).collect();

            // Perform inverse FFT
            col_ifft.process(&mut buffer);

            // Update column with IFFT result
            for (i, val) in buffer.iter().enumerate() {
                col[i] = Complex64::new(val.re, val.im);
            }
        }
    }

    // Apply appropriate normalization
    let total_elements = outputshape.0 * outputshape.1;
    let scale = match norm_mode {
        NormMode::Backward => 1.0 / (total_elements as f64),
        NormMode::Ortho => 1.0 / (total_elements as f64).sqrt(),
        NormMode::Forward => 1.0, // No additional normalization for forward mode in IFFT
        NormMode::None => 1.0,    // No normalization
    };

    if scale != 1.0 {
        padded_input.mapv_inplace(|x| x * scale);
    }

    Ok(padded_input)
}

/// Compute the N-dimensional Fast Fourier Transform
///
/// # Arguments
///
/// * `input` - Input N-dimensional array
/// * `shape` - Shape of the output (optional)
/// * `axes` - Axes along which to compute the FFT (optional)
/// * `norm` - Normalization mode: "backward", "ortho", or "forward" (optional)
/// * `overwrite_x` - Whether to overwrite the input array (optional)
/// * `workers` - Number of worker threads to use (optional)
///
/// # Returns
///
/// An N-dimensional array of complex values representing the FFT result
///
/// # Examples
///
/// ```
/// use scirs2_fft::fftn;
/// use scirs2_core::ndarray::{Array, IxDyn};
///
/// // Create a 3D array
/// let mut data = Array::zeros(IxDyn(&[2, 2, 2]));
/// data[[0, 0, 0]] = 1.0;
/// data[[1, 1, 1]] = 1.0;
///
/// // Compute the N-dimensional FFT
/// let result = fftn(&data, None, None, None, None, None).expect("valid input");
///
/// // Check dimensions
/// assert_eq!(result.shape(), &[2, 2, 2]);
/// ```
#[allow(clippy::too_many_arguments)]
#[allow(dead_code)]
#[allow(unreachable_code)]
pub fn fftn<T>(
    input: &ArrayD<T>,
    shape: Option<Vec<usize>>,
    axes: Option<Vec<usize>>,
    norm: Option<&str>,
    _overwrite_x: Option<bool>,
    _workers: Option<usize>,
) -> FFTResult<ArrayD<Complex64>>
where
    T: NumCast + Copy + Debug + 'static,
{
    let inputshape = input.shape().to_vec();
    let input_ndim = inputshape.len();

    // Determine output shape
    let outputshape = shape.unwrap_or_else(|| inputshape.clone());

    // Validate output shape
    if outputshape.len() != input_ndim {
        return Err(FFTError::ValueError(
            "Output shape must have the same number of dimensions as input".to_string(),
        ));
    }

    // Determine axes to perform FFT on
    let axes = axes.unwrap_or_else(|| (0..input_ndim).collect());

    // Validate axes
    for &axis in &axes {
        if axis >= input_ndim {
            return Err(FFTError::ValueError(format!(
                "Axis {axis} out of bounds for array of dimension {input_ndim}"
            )));
        }
    }

    // Parse normalization mode
    let norm_mode = parse_norm_mode(norm, false);

    // Convert input array to complex
    let mut complex_input = ArrayD::<Complex64>::zeros(IxDyn(&inputshape));
    for (idx, &val) in input.iter().enumerate() {
        let mut idx_vec = Vec::with_capacity(input_ndim);
        let mut remaining = idx;

        for &dim in input.shape().iter().rev() {
            idx_vec.push(remaining % dim);
            remaining /= dim;
        }

        idx_vec.reverse();

        complex_input[IxDyn(&idx_vec)] = convert_to_complex(val)?;
    }

    // Pad or truncate to match output shape if necessary
    let mut result = if inputshape != outputshape {
        let mut padded = ArrayD::<Complex64>::zeros(IxDyn(&outputshape));

        // Copy all elements that fit within both arrays
        for (idx, &val) in complex_input.iter().enumerate() {
            let mut idx_vec = Vec::with_capacity(input_ndim);
            let mut remaining = idx;

            for &dim in input.shape().iter().rev() {
                idx_vec.push(remaining % dim);
                remaining /= dim;
            }

            idx_vec.reverse();

            let mut in_bounds = true;
            for (dim, &idx_val) in idx_vec.iter().enumerate() {
                if idx_val >= outputshape[dim] {
                    in_bounds = false;
                    break;
                }
            }

            if in_bounds {
                padded[IxDyn(&idx_vec)] = val;
            }
        }

        padded
    } else {
        complex_input
    };

    // Perform FFT along each axis
    #[cfg(feature = "oxifft")]
    {
        for &axis in &axes {
            let axis_len = outputshape[axis];

            // For each slice along the current axis
            let axis_obj = Axis(axis);

            for mut lane in result.lanes_mut(axis_obj) {
                // Convert to OxiFFT compatible format
                let input_oxi: Vec<OxiComplex<f64>> =
                    lane.iter().map(|&c| OxiComplex::new(c.re, c.im)).collect();
                let mut output: Vec<OxiComplex<f64>> = vec![OxiComplex::zero(); axis_len];

                // Perform FFT
                oxifft_plan_cache::execute_c2c(&input_oxi, &mut output, Direction::Forward)?;

                // Update lane with FFT result
                for (i, val) in output.iter().enumerate() {
                    lane[i] = Complex64::new(val.re, val.im);
                }
            }
        }
    }

    #[cfg(not(feature = "oxifft"))]
    {
        #[cfg(feature = "rustfft-backend")]
        {
            // Create FFT planner
            let mut planner = FftPlanner::new();

            // Perform FFT along each axis
            for &axis in &axes {
                let axis_len = outputshape[axis];
                let fft = planner.plan_fft_forward(axis_len);

                // For each slice along the current axis
                let axis_obj = Axis(axis);

                for mut lane in result.lanes_mut(axis_obj) {
                    // Convert to rustfft compatible format
                    let mut buffer: Vec<RustComplex<f64>> =
                        lane.iter().map(|&c| RustComplex::new(c.re, c.im)).collect();

                    // Perform FFT
                    fft.process(&mut buffer);

                    // Update lane with FFT result
                    for (i, val) in buffer.iter().enumerate() {
                        lane[i] = Complex64::new(val.re, val.im);
                    }
                }
            }
        }

        #[cfg(not(feature = "rustfft-backend"))]
        {
            return Err(FFTError::ComputationError(
                "No FFT backend available. Enable either 'oxifft' or 'rustfft-backend' feature."
                    .to_string(),
            ));
        }
    }

    // Apply normalization if needed
    if norm_mode != NormMode::None {
        let total_elements: usize = outputshape.iter().product();
        let scale = match norm_mode {
            NormMode::Backward => 1.0 / (total_elements as f64),
            NormMode::Ortho => 1.0 / (total_elements as f64).sqrt(),
            NormMode::Forward => 1.0 / (total_elements as f64),
            NormMode::None => 1.0, // Should not happen due to earlier check
        };

        result.mapv_inplace(|_x| _x * scale);
    }

    Ok(result)
}

/// Compute the inverse N-dimensional Fast Fourier Transform
///
/// # Arguments
///
/// * `input` - Input N-dimensional array
/// * `shape` - Shape of the output (optional)
/// * `axes` - Axes along which to compute the inverse FFT (optional)
/// * `norm` - Normalization mode: "backward", "ortho", or "forward" (optional)
/// * `overwrite_x` - Whether to overwrite the input array (optional)
/// * `workers` - Number of worker threads to use (optional)
///
/// # Returns
///
/// An N-dimensional array of complex values representing the inverse FFT result
///
/// # Examples
///
/// ```
/// use scirs2_fft::{fftn, ifftn};
/// use scirs2_core::ndarray::{Array, IxDyn};
/// use scirs2_core::numeric::Complex64;
///
/// // Create a 3D array
/// let mut data = Array::zeros(IxDyn(&[2, 2, 2]));
/// data[[0, 0, 0]] = 1.0;
/// data[[1, 1, 1]] = 1.0;
///
/// // Compute the N-dimensional FFT
/// let spectrum = fftn(&data, None, None, None, None, None).expect("valid input");
///
/// // Compute the inverse N-dimensional FFT
/// let result = ifftn(&spectrum, None, None, None, None, None).expect("valid input");
///
/// // Check if the original data is recovered
/// for i in 0..2 {
///     for j in 0..2 {
///         for k in 0..2 {
///             let expected = if (i == 0 && j == 0 && k == 0) || (i == 1 && j == 1 && k == 1) {
///                 1.0
///             } else {
///                 0.0
///             };
///             assert!((result[[i, j, k]].re - expected).abs() < 1e-10);
///             assert!(result[[i, j, k]].im.abs() < 1e-10);
///         }
///     }
/// }
/// ```
#[allow(clippy::too_many_arguments)]
#[allow(dead_code)]
#[allow(unreachable_code)]
pub fn ifftn<T>(
    input: &ArrayD<T>,
    shape: Option<Vec<usize>>,
    axes: Option<Vec<usize>>,
    norm: Option<&str>,
    _overwrite_x: Option<bool>,
    _workers: Option<usize>,
) -> FFTResult<ArrayD<Complex64>>
where
    T: NumCast + Copy + Debug + 'static,
{
    let inputshape = input.shape().to_vec();
    let input_ndim = inputshape.len();

    // Determine output shape
    let outputshape = shape.unwrap_or_else(|| inputshape.clone());

    // Validate output shape
    if outputshape.len() != input_ndim {
        return Err(FFTError::ValueError(
            "Output shape must have the same number of dimensions as input".to_string(),
        ));
    }

    // Determine axes to perform FFT on
    let axes = axes.unwrap_or_else(|| (0..input_ndim).collect());

    // Validate axes
    for &axis in &axes {
        if axis >= input_ndim {
            return Err(FFTError::ValueError(format!(
                "Axis {axis} out of bounds for array of dimension {input_ndim}"
            )));
        }
    }

    // Parse normalization mode (default is "backward" for inverse FFT)
    let norm_mode = parse_norm_mode(norm, true);

    // Create workspace array - convert input to complex first
    let mut complex_input = ArrayD::<Complex64>::zeros(IxDyn(&inputshape));
    for (idx, &val) in input.iter().enumerate() {
        let mut idx_vec = Vec::with_capacity(input_ndim);
        let mut remaining = idx;

        for &dim in input.shape().iter().rev() {
            idx_vec.push(remaining % dim);
            remaining /= dim;
        }

        idx_vec.reverse();

        // Try to convert to Complex64
        complex_input[IxDyn(&idx_vec)] = convert_to_complex(val)?;
    }

    // Now handle padding/resizing if needed
    let mut result = if inputshape != outputshape {
        let mut padded = ArrayD::<Complex64>::zeros(IxDyn(&outputshape));

        // Copy all elements that fit within both arrays
        for (idx, &val) in complex_input.iter().enumerate() {
            let mut idx_vec = Vec::with_capacity(input_ndim);
            let mut remaining = idx;

            for &dim in input.shape().iter().rev() {
                idx_vec.push(remaining % dim);
                remaining /= dim;
            }

            idx_vec.reverse();

            let mut in_bounds = true;
            for (dim, &idx_val) in idx_vec.iter().enumerate() {
                if idx_val >= outputshape[dim] {
                    in_bounds = false;
                    break;
                }
            }

            if in_bounds {
                padded[IxDyn(&idx_vec)] = val;
            }
        }

        padded
    } else {
        complex_input
    };

    // Perform inverse FFT along each axis
    #[cfg(feature = "oxifft")]
    {
        for &axis in &axes {
            let axis_len = outputshape[axis];

            // For each slice along the current axis
            let axis_obj = Axis(axis);

            for mut lane in result.lanes_mut(axis_obj) {
                // Convert to OxiFFT compatible format
                let input_oxi: Vec<OxiComplex<f64>> =
                    lane.iter().map(|&c| OxiComplex::new(c.re, c.im)).collect();
                let mut output: Vec<OxiComplex<f64>> = vec![OxiComplex::zero(); axis_len];

                // Perform inverse FFT
                oxifft_plan_cache::execute_c2c(&input_oxi, &mut output, Direction::Backward)?;

                // Update lane with IFFT result
                for (i, val) in output.iter().enumerate() {
                    lane[i] = Complex64::new(val.re, val.im);
                }
            }
        }
    }

    #[cfg(not(feature = "oxifft"))]
    {
        #[cfg(feature = "rustfft-backend")]
        {
            // Create FFT planner
            let mut planner = FftPlanner::new();

            // Perform inverse FFT along each axis
            for &axis in &axes {
                let axis_len = outputshape[axis];
                let ifft = planner.plan_fft_inverse(axis_len);

                // For each slice along the current axis
                let axis_obj = Axis(axis);

                for mut lane in result.lanes_mut(axis_obj) {
                    // Convert to rustfft compatible format
                    let mut buffer: Vec<RustComplex<f64>> =
                        lane.iter().map(|&c| RustComplex::new(c.re, c.im)).collect();

                    // Perform inverse FFT
                    ifft.process(&mut buffer);

                    // Update lane with IFFT result
                    for (i, val) in buffer.iter().enumerate() {
                        lane[i] = Complex64::new(val.re, val.im);
                    }
                }
            }
        }

        #[cfg(not(feature = "rustfft-backend"))]
        {
            return Err(FFTError::ComputationError(
                "No FFT backend available. Enable either 'oxifft' or 'rustfft-backend' feature."
                    .to_string(),
            ));
        }
    }

    // Apply appropriate normalization
    if norm_mode != NormMode::None {
        let total_elements: usize = axes.iter().map(|&a| outputshape[a]).product();
        let scale = match norm_mode {
            NormMode::Backward => 1.0 / (total_elements as f64),
            NormMode::Ortho => 1.0 / (total_elements as f64).sqrt(),
            NormMode::Forward => 1.0, // No additional normalization
            NormMode::None => 1.0,    // No normalization
        };

        if scale != 1.0 {
            result.mapv_inplace(|_x| _x * scale);
        }
    }

    Ok(result)
}