argmin-math 0.5.1

argmin math abstractions
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

// Copyright 2018-2024 argmin developers
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

use crate::{ArgminZero, ArgminZeroLike};
use num_complex::Complex;

macro_rules! make_zero {
    ($t:ty) => {
        impl ArgminZero for $t {
            #[allow(clippy::cast_lossless)]
            #[inline]
            fn zero() -> $t {
                0 as $t
            }
        }
        impl ArgminZeroLike for $t {
            #[allow(clippy::cast_lossless)]
            #[inline]
            fn zero_like(&self) -> $t {
                0 as $t
            }
        }
    };
}

macro_rules! make_complex_zero {
    ($t:ty) => {
        impl ArgminZero for Complex<$t> {
            #[allow(clippy::cast_lossless)]
            #[inline]
            fn zero() -> Complex<$t> {
                Complex::new(0 as $t, 0 as $t)
            }
        }
        impl ArgminZeroLike for Complex<$t> {
            #[allow(clippy::cast_lossless)]
            #[inline]
            fn zero_like(&self) -> Complex<$t> {
                Complex::new(0 as $t, 0 as $t)
            }
        }
    };
}

make_zero!(f32);
make_zero!(f64);
make_zero!(i8);
make_zero!(i16);
make_zero!(i32);
make_zero!(i64);
make_zero!(u8);
make_zero!(u16);
make_zero!(u32);
make_zero!(u64);
make_complex_zero!(f32);
make_complex_zero!(f64);
make_complex_zero!(i8);
make_complex_zero!(i16);
make_complex_zero!(i32);
make_complex_zero!(i64);
make_complex_zero!(u8);
make_complex_zero!(u16);
make_complex_zero!(u32);
make_complex_zero!(u64);

#[cfg(test)]
mod tests {
    use super::*;
    use approx::assert_relative_eq;
    use paste::item;

    macro_rules! make_test {
        ($t:ty) => {
            item! {
                #[test]
                fn [<test_zero_ $t>]() {
                    let a = <$t as ArgminZero>::zero();
                    assert_relative_eq!(0 as f64, a as f64, epsilon = f64::EPSILON);
                }
            }

            item! {
                #[test]
                fn [<test_zero_complex_ $t>]() {
                    let a = <Complex<$t> as ArgminZero>::zero();
                    assert_relative_eq!(0 as f64, a.re as f64, epsilon = f64::EPSILON);
                    assert_relative_eq!(0 as f64, a.im as f64, epsilon = f64::EPSILON);
                }
            }

            item! {
                #[test]
                fn [<test_zero_like_ $t>]() {
                    let a = (42 as $t).zero_like();
                    assert_relative_eq!(0 as f64, a as f64, epsilon = f64::EPSILON);
                }
            }

            item! {
                #[test]
                fn [<test_zero_like_complex_ $t>]() {
                    let a = Complex::new(42 as $t, 12 as $t).zero_like();
                    assert_relative_eq!(0 as f64, a.re as f64, epsilon = f64::EPSILON);
                    assert_relative_eq!(0 as f64, a.im as f64, epsilon = f64::EPSILON);
                }
            }
        };
    }

    make_test!(i8);
    make_test!(u8);
    make_test!(i16);
    make_test!(u16);
    make_test!(i32);
    make_test!(u32);
    make_test!(i64);
    make_test!(u64);
    make_test!(f32);
    make_test!(f64);
}