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

// 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::ArgminRandom;
use rand::Rng;

macro_rules! make_random {
    ($t:ty) => {
        impl ArgminRandom for Vec<$t> {
            fn rand_from_range<R: Rng>(min: &Self, max: &Self, rng: &mut R) -> Vec<$t> {
                assert!(!min.is_empty());
                assert_eq!(min.len(), max.len());

                min.iter()
                    .zip(max.iter())
                    .map(|(a, b)| {
                        // Do not require a < b:

                        // We do want to know if a and b are *exactly* the same.
                        #[allow(clippy::float_cmp)]
                        if a == b {
                            a.clone()
                        } else if a < b {
                            rng.random_range(a.clone()..b.clone())
                        } else {
                            rng.random_range(b.clone()..a.clone())
                        }
                    })
                    .collect()
            }
        }

        impl ArgminRandom for Vec<Vec<$t>> {
            fn rand_from_range<R: Rng>(min: &Self, max: &Self, rng: &mut R) -> Vec<Vec<$t>> {
                assert!(!min.is_empty());
                assert_eq!(min.len(), max.len());
                min.iter()
                    .zip(max.iter())
                    .map(|(a, b)| Vec::<$t>::rand_from_range(a, b, rng))
                    .collect()
            }
        }
    };
}

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

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

    macro_rules! make_test {
        ($t:ty) => {
            item! {
                #[test]
                fn [<test_random_vec_ $t>]() {
                    let a = vec![1 as $t, 2 as $t, 4 as $t];
                    let b = vec![2 as $t, 3 as $t, 5 as $t];
                    let mut rng = rand::rngs::StdRng::seed_from_u64(42);
                    let random = Vec::<$t>::rand_from_range(&a, &b, &mut rng);
                    for i in 0..3usize {
                        assert!(random[i] >= a[i]);
                        assert!(random[i] <= b[i]);
                    }
                }
            }

            item! {
                #[test]
                fn [<test_random_mat_ $t>]() {
                    let a = vec![
                        vec![1 as $t, 2 as $t, 4 as $t],
                        vec![2 as $t, 3 as $t, 5 as $t]
                    ];
                    let b = vec![
                        vec![2 as $t, 3 as $t, 5 as $t],
                        vec![3 as $t, 4 as $t, 6 as $t]
                    ];
                    let mut rng = rand::rngs::StdRng::seed_from_u64(42);
                    let random = Vec::<Vec<$t>>::rand_from_range(&a, &b, &mut rng);
                    for i in 0..3 {
                        for j in 0..2 {
                            assert!(random[j][i] >= a[j][i]);
                            assert!(random[j][i] <= b[j][i]);
                        }
                    }
                }
            }
        };
    }

    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);
}