argmin_math/vec/
l2norm.rs

1// Copyright 2018-2024 argmin developers
2//
3// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
4// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
5// http://opensource.org/licenses/MIT>, at your option. This file may not be
6// copied, modified, or distributed except according to those terms.
7
8use crate::ArgminL2Norm;
9use num_complex::Complex;
10use num_integer::Roots;
11
12macro_rules! make_norm_float {
13    ($t:ty) => {
14        impl ArgminL2Norm<$t> for Vec<$t> {
15            #[inline]
16            fn l2_norm(&self) -> $t {
17                self.iter().map(|a| a.powi(2)).sum::<$t>().sqrt()
18            }
19        }
20    };
21}
22
23macro_rules! make_norm_integer {
24    ($t:ty) => {
25        impl ArgminL2Norm<$t> for Vec<$t> {
26            #[inline]
27            fn l2_norm(&self) -> $t {
28                self.iter().map(|a| a.pow(2)).sum::<$t>().sqrt()
29            }
30        }
31    };
32}
33
34macro_rules! make_norm_complex {
35    ($i: ty, $t:ty) => {
36        impl ArgminL2Norm<$t> for Vec<$i> {
37            #[inline]
38            fn l2_norm(&self) -> $t {
39                self.iter().map(|a| a.norm_sqr()).sum::<$t>().sqrt()
40            }
41        }
42    };
43}
44
45macro_rules! make_norm_unsigned {
46    ($t:ty) => {
47        impl ArgminL2Norm<$t> for Vec<$t> {
48            #[inline]
49            fn l2_norm(&self) -> $t {
50                self.iter().map(|a| a.pow(2)).sum::<$t>().sqrt()
51            }
52        }
53    };
54}
55
56make_norm_unsigned!(u8);
57make_norm_unsigned!(u16);
58make_norm_unsigned!(u32);
59make_norm_unsigned!(u64);
60make_norm_integer!(i8);
61make_norm_integer!(i16);
62make_norm_integer!(i32);
63make_norm_integer!(i64);
64make_norm_float!(f32);
65make_norm_float!(f64);
66make_norm_complex!(Complex<i8>, i8);
67make_norm_complex!(Complex<i16>, i16);
68make_norm_complex!(Complex<i32>, i32);
69make_norm_complex!(Complex<i64>, i64);
70make_norm_complex!(Complex<u8>, u8);
71make_norm_complex!(Complex<u16>, u16);
72make_norm_complex!(Complex<u32>, u32);
73make_norm_complex!(Complex<u64>, u64);
74make_norm_complex!(Complex<f32>, f32);
75make_norm_complex!(Complex<f64>, f64);
76
77#[cfg(test)]
78mod tests {
79    use super::*;
80    use approx::assert_relative_eq;
81    use paste::item;
82
83    macro_rules! make_test {
84        ($t:ty) => {
85            item! {
86                #[test]
87                fn [<test_norm_ $t>]() {
88                    let a = vec![4 as $t, 3 as $t];
89                    let res = <Vec<$t> as ArgminL2Norm<$t>>::l2_norm(&a);
90                    let target = 5 as $t;
91                    assert_relative_eq!(target as f64, res as f64, epsilon = f64::EPSILON);
92                }
93            }
94
95            item! {
96                #[test]
97                fn [<test_norm_complex_ $t>]() {
98                    let a = vec![Complex::new(4 as $t, 2 as $t), Complex::new(3 as $t, 4 as $t)];
99                    let res = <Vec<Complex<$t>> as ArgminL2Norm<$t>>::l2_norm(&a);
100                    let target = (a[0].norm_sqr() + a[1].norm_sqr()).sqrt();
101                    assert_relative_eq!(target as f64, res as f64, epsilon = f64::EPSILON);
102                }
103            }
104        };
105    }
106
107    macro_rules! make_test_signed {
108        ($t:ty) => {
109            item! {
110                #[test]
111                fn [<test_norm_signed_ $t>]() {
112                    let a = vec![-4 as $t, -3 as $t];
113                    let res = <Vec<$t> as ArgminL2Norm<$t>>::l2_norm(&a);
114                    let target = 5 as $t;
115                    assert_relative_eq!(target as f64, res as f64, epsilon = f64::EPSILON);
116                }
117            }
118
119            item! {
120                #[test]
121                fn [<test_norm_signed_complex_ $t>]() {
122                    let a = vec![Complex::new(-4 as $t, -2 as $t), Complex::new(-3 as $t, -4 as $t)];
123                    let res = <Vec<Complex<$t>> as ArgminL2Norm<$t>>::l2_norm(&a);
124                    let target = (a[0].norm_sqr() + a[1].norm_sqr()).sqrt();
125                    assert_relative_eq!(target as f64, res as f64, epsilon = f64::EPSILON);
126                }
127            }
128        };
129    }
130
131    make_test!(i8);
132    make_test!(u8);
133    make_test!(i16);
134    make_test!(u16);
135    make_test!(i32);
136    make_test!(u32);
137    make_test!(i64);
138    make_test!(u64);
139    make_test!(f32);
140    make_test!(f64);
141
142    make_test_signed!(i8);
143    make_test_signed!(i16);
144    make_test_signed!(i32);
145    make_test_signed!(i64);
146    make_test_signed!(f32);
147    make_test_signed!(f64);
148}
argmin_math/vec/l2norm.rs

argmin_math/vec/
l2norm.rs
