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
125
126
127
128
129
130
131
132
133
134

// 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 rand::{distr::uniform::SampleUniform, Rng};

use crate::{Allocator, ArgminRandom};

use nalgebra::{
    base::{dimension::Dim, Scalar},
    DefaultAllocator, OMatrix,
};

impl<N, R, C> ArgminRandom for OMatrix<N, R, C>
where
    N: Scalar + PartialOrd + SampleUniform,
    R: Dim,
    C: Dim,
    DefaultAllocator: Allocator<N, R, C>,
{
    #[inline]
    fn rand_from_range<T: Rng>(min: &Self, max: &Self, rng: &mut T) -> OMatrix<N, R, C> {
        assert!(!min.is_empty());
        assert_eq!(min.shape(), max.shape());

        Self::from_iterator_generic(
            R::from_usize(min.nrows()),
            C::from_usize(min.ncols()),
            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())
                }
            }),
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use nalgebra::{Matrix2x3, Vector3};
    use paste::item;
    use rand::SeedableRng;

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

            item! {
                #[test]
                fn [<test_random_vec_equal $t>]() {
                    let a = Vector3::new(1 as $t, 2 as $t, 3 as $t);
                    let b = Vector3::new(1 as $t, 2 as $t, 3 as $t);
                    let mut rng = rand::rngs::StdRng::seed_from_u64(42);
                    let random = Vector3::<$t>::rand_from_range(&a, &b, &mut rng);
                    for i in 0..3 {
                        assert!((random[i] as f64 - a[i] as f64).abs() < f64::EPSILON);
                        assert!((random[i] as f64 - b[i] as f64).abs() < f64::EPSILON);
                    }
                }
            }

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

            item! {
                #[test]
                fn [<test_random_mat_ $t>]() {
                    let a = Matrix2x3::new(
                        1 as $t, 3 as $t, 5 as $t,
                        2 as $t, 4 as $t, 6 as $t
                    );
                    let b = Matrix2x3::new(
                        2 as $t, 4 as $t, 6 as $t,
                        3 as $t, 5 as $t, 7 as $t
                    );
                    let mut rng = rand::rngs::StdRng::seed_from_u64(42);
                    let random = Matrix2x3::<$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);
}