russell_lab 1.13.0

Scientific laboratory for linear algebra and numerical mathematics
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

use crate::{ComplexMatrix, Matrix, StrError};

/// Zips two arrays (real and imag) to make a new ComplexMatrix
///
/// # Examples
///
/// ```
/// use russell_lab::*;
///
/// fn main() -> Result<(), StrError> {
///     let a = ComplexMatrix::from(&[
///         [cpx!(1.0, 0.1), cpx!(2.0, 0.2), cpx!(3.0, 0.3)],
///         [cpx!(4.0, 0.4), cpx!(5.0, 0.5), cpx!(6.0, 0.6)],
///     ]);
///     let mut real = Matrix::new(2, 3);
///     let mut imag = Matrix::new(2, 3);
///     complex_mat_unzip(&mut real, &mut imag, &a)?;
///     assert_eq!(
///         format!("{}", real),
///         "┌       ┐\n\
///          │ 1 2 3 │\n\
///          │ 4 5 6 │\n\
///          └       ┘"
///     );
///     assert_eq!(
///         format!("{}", imag),
///         "┌             ┐\n\
///          │ 0.1 0.2 0.3 │\n\
///          │ 0.4 0.5 0.6 │\n\
///          └             ┘"
///     );
///     Ok(())
/// }
/// ```
pub fn complex_mat_unzip(real: &mut Matrix, imag: &mut Matrix, a: &ComplexMatrix) -> Result<(), StrError> {
    let (nrow, ncol) = a.dims();
    let (nrow_re, ncol_re) = real.dims();
    let (nrow_im, ncol_im) = imag.dims();
    if nrow_re != nrow || ncol_re != ncol || nrow_im != nrow || ncol_im != ncol {
        return Err("matrices are incompatible");
    }
    for i in 0..nrow {
        for j in 0..ncol {
            real.set(i, j, a.get(i, j).re);
            imag.set(i, j, a.get(i, j).im);
        }
    }
    Ok(())
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

#[cfg(test)]
mod tests {
    use super::complex_mat_unzip;
    use crate::{cpx, mat_approx_eq, Complex64, ComplexMatrix, Matrix};

    #[test]
    fn complex_mat_unzip_handles_errors() {
        let a = ComplexMatrix::new(2, 2);
        let mut wrong_1x2 = Matrix::new(1, 2);
        let mut wrong_2x1 = Matrix::new(2, 1);
        let mut ok = Matrix::new(2, 2);
        assert_eq!(
            complex_mat_unzip(&mut wrong_1x2, &mut ok, &a).err(),
            Some("matrices are incompatible")
        );
        assert_eq!(
            complex_mat_unzip(&mut wrong_2x1, &mut ok, &a).err(),
            Some("matrices are incompatible")
        );
        assert_eq!(
            complex_mat_unzip(&mut ok, &mut wrong_1x2, &a).err(),
            Some("matrices are incompatible")
        );
        assert_eq!(
            complex_mat_unzip(&mut ok, &mut wrong_2x1, &a).err(),
            Some("matrices are incompatible")
        );
    }

    #[test]
    fn complex_mat_unzip_works() {
        let a = ComplexMatrix::from(&[
            [cpx!(1.0, 0.1), cpx!(2.0, 0.2), cpx!(3.0, 0.3)],
            [cpx!(4.0, 0.4), cpx!(5.0, 0.5), cpx!(6.0, 0.6)],
        ]);
        let mut real = Matrix::new(2, 3);
        let mut imag = Matrix::new(2, 3);
        complex_mat_unzip(&mut real, &mut imag, &a).unwrap();
        mat_approx_eq(&real, &[[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]], 1e-15);
        mat_approx_eq(&imag, &[[0.1, 0.2, 0.3], [0.4, 0.5, 0.6]], 1e-15);
    }
}