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
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

use super::ComplexVector;
use crate::{array_plus_opx_complex, Complex64, StrError};

/// Performs the addition of two vectors
///
/// ```text
/// w := α⋅u + β⋅v
/// ```
///
/// # Examples
///
/// ```
/// use russell_lab::*;
///
/// fn main() -> Result<(), StrError> {
///     let u = ComplexVector::from(&[10.0, 20.0, 30.0, 40.0]);
///     let v = ComplexVector::from(&[2.0, 1.5, 1.0, 0.5]);
///     let mut w = ComplexVector::new(4);
///     let alpha = cpx!(0.1, 0.0);
///     let beta = cpx!(2.0, 0.0);
///     complex_vec_add(&mut w, alpha, &u, beta, &v)?;
///     let correct = "┌      ┐\n\
///                    │ 5+0i │\n\
///                    │ 5+0i │\n\
///                    │ 5+0i │\n\
///                    │ 5+0i │\n\
///                    └      ┘";
///     assert_eq!(format!("{}", w), correct);
///     Ok(())
/// }
/// ```
pub fn complex_vec_add(
    w: &mut ComplexVector,
    alpha: Complex64,
    u: &ComplexVector,
    beta: Complex64,
    v: &ComplexVector,
) -> Result<(), StrError> {
    array_plus_opx_complex(w.as_mut_data(), alpha, u.as_data(), beta, v.as_data())
}

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

#[cfg(test)]
mod tests {
    use super::complex_vec_add;
    use crate::{complex_vec_approx_eq, cpx, Complex64, ComplexVector, MAX_DIM_FOR_NATIVE_BLAS};

    #[test]
    fn complex_vec_add_fail_on_wrong_dims() {
        let u_2 = ComplexVector::new(2);
        let u_3 = ComplexVector::new(3);
        let v_2 = ComplexVector::new(2);
        let v_3 = ComplexVector::new(3);
        let mut w_2 = ComplexVector::new(2);
        let alpha = cpx!(1.0, 0.0);
        let beta = cpx!(1.0, 0.0);
        assert_eq!(
            complex_vec_add(&mut w_2, alpha, &u_3, beta, &v_2),
            Err("arrays are incompatible")
        );
        assert_eq!(
            complex_vec_add(&mut w_2, alpha, &u_2, beta, &v_3),
            Err("arrays are incompatible")
        );
    }

    #[test]
    fn complex_vec_add_works() {
        const NOISE: Complex64 = cpx!(1234.567, 3456.789);
        #[rustfmt::skip]
        let u = ComplexVector::from(&[
            1.0, 2.0,
            1.0, 2.0, 3.0, 4.0,
            1.0, 2.0, 3.0, 4.0,
            1.0, 2.0, 3.0, 4.0,
            1.0, 2.0, 3.0, 4.0,
        ]);
        #[rustfmt::skip]
        let v = ComplexVector::from(&[
            0.5, 1.0,
            0.5, 1.0, 1.5, 2.0,
            0.5, 1.0, 1.5, 2.0,
            0.5, 1.0, 1.5, 2.0,
            0.5, 1.0, 1.5, 2.0,
        ]);
        let mut w = ComplexVector::from(&vec![NOISE; u.dim()]);
        let alpha = cpx!(1.0, 0.0);
        let beta = cpx!(-4.0, 0.0);
        complex_vec_add(&mut w, alpha, &u, beta, &v).unwrap();
        #[rustfmt::skip]
        let correct = &[
            cpx!(-1.0,0.0), cpx!(-2.0,0.0),
            cpx!(-1.0,0.0), cpx!(-2.0,0.0), cpx!(-3.0,0.0), cpx!(-4.0,0.0),
            cpx!(-1.0,0.0), cpx!(-2.0,0.0), cpx!(-3.0,0.0), cpx!(-4.0,0.0),
            cpx!(-1.0,0.0), cpx!(-2.0,0.0), cpx!(-3.0,0.0), cpx!(-4.0,0.0),
            cpx!(-1.0,0.0), cpx!(-2.0,0.0), cpx!(-3.0,0.0), cpx!(-4.0,0.0),
        ];
        complex_vec_approx_eq(&w, correct, 1e-15);
    }

    #[test]
    fn complex_vec_add_sizes_works() {
        const NOISE: Complex64 = cpx!(1234.567, 3456.789);
        let alpha = cpx!(0.5, 0.0);
        let beta = cpx!(0.5, 0.0);
        for size in 0..(MAX_DIM_FOR_NATIVE_BLAS + 3) {
            let mut u = ComplexVector::new(size);
            let mut v = ComplexVector::new(size);
            let mut w = ComplexVector::from(&vec![NOISE; u.dim()]);
            let mut correct = vec![cpx!(0.0, 0.0); size];
            for i in 0..size {
                u[i] = cpx!(i as f64, i as f64);
                v[i] = cpx!(i as f64, i as f64);
                correct[i] = cpx!(i as f64, i as f64);
            }
            complex_vec_add(&mut w, alpha, &u, beta, &v).unwrap();
            complex_vec_approx_eq(&w, &correct, 1e-15);
        }
    }
}