russell_lab 1.11.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

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

/// Zips two arrays (real and imag) to make a new ComplexMatrix
///
/// # Examples
///
/// ```
/// use russell_lab::*;
///
/// fn main() -> Result<(), StrError> {
///     let mut a = ComplexMatrix::new(2, 3);
///     let real = Matrix::from(&[[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]]);
///     let imag = Matrix::from(&[[0.1, 0.2, 0.3], [-0.4, -0.5, -0.6]]);
///     complex_mat_zip(&mut a, &real, &imag)?;
///     assert_eq!(
///         format!("{}", a),
///         "┌                      ┐\n\
///          │ 1+0.1i 2+0.2i 3+0.3i │\n\
///          │ 4-0.4i 5-0.5i 6-0.6i │\n\
///          └                      ┘"
///     );
///     Ok(())
/// }
/// ```
pub fn complex_mat_zip(a: &mut ComplexMatrix, real: &Matrix, imag: &Matrix) -> 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 {
            a.set(i, j, Complex64::new(real.get(i, j), imag.get(i, j)));
        }
    }
    Ok(())
}

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

#[cfg(test)]
mod tests {
    use super::complex_mat_zip;
    use crate::{ComplexMatrix, Matrix};

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

    #[test]
    fn complex_mat_zip_works() {
        let real = Matrix::from(&[[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]]);
        let imag = Matrix::from(&[[0.1, 0.2, 0.3], [0.4, 0.5, 0.6]]);
        let mut c = ComplexMatrix::new(2, 3);
        complex_mat_zip(&mut c, &real, &imag).unwrap();
        assert_eq!(
            format!("{}", c),
            "┌                      ┐\n\
             │ 1+0.1i 2+0.2i 3+0.3i │\n\
             │ 4+0.4i 5+0.5i 6+0.6i │\n\
             └                      ┘"
        );
    }
}