argmin_math/ndarray_m/
random.rs

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

use crate::ArgminRandom;

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

                ndarray::Array1::from_iter(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.gen_range(a.clone()..b.clone())
                    } else {
                        rng.gen_range(b.clone()..a.clone())
                    }
                }))
            }
        }

        impl ArgminRandom for ndarray::Array2<$t> {
            fn rand_from_range<R: Rng>(min: &Self, max: &Self, rng: &mut R) -> ndarray::Array2<$t> {
                assert!(!min.is_empty());
                assert_eq!(min.raw_dim(), max.raw_dim());

                ndarray::Array2::from_shape_fn(min.raw_dim(), |(i, j)| {
                    let a = min.get((i, j)).unwrap();
                    let b = max.get((i, j)).unwrap();

                    // 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.gen_range(a.clone()..b.clone())
                    } else {
                        rng.gen_range(b.clone()..a.clone())
                    }
                })
            }
        }
    };
}

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

// All code that does not depend on a linked ndarray-linalg backend can still be tested as normal.
// To avoid dublicating tests and to allow convenient testing of functionality that does not need ndarray-linalg the tests are still included here.
// The tests expect the name for the crate containing the tested functions to be argmin_math
#[cfg(test)]
use crate as argmin_math;
include!(concat!(
    env!("CARGO_MANIFEST_DIR"),
    "/ndarray-tests-src/random.rs"
));