odesign 0.1.9

odesign is an optimal design of experiments library written in pure rust.
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
135
136

use crate::{Error, Result};
use nalgebra::{Const, Dyn, Matrix, SVector, VecStorage};

/// Cubic grid defined by lower/upper bound and the dimensional sample number q.
#[derive(Debug, PartialEq)]
pub struct Grid<const D: usize> {
    /// Lower bound.
    pub lower: SVector<f64, D>,
    /// Upper bound.
    pub upper: SVector<f64, D>,
    /// Sample number per dimension.
    pub q: SVector<usize, D>,
    /// Set of points in grid.
    pub points: Matrix<f64, Const<D>, Dyn, VecStorage<f64, Const<D>, Dyn>>,
}

impl<const D: usize> Grid<D> {
    /// Creates cubic grid with help of generating the cartesian product.
    pub fn new(
        lower: SVector<f64, D>,
        upper: SVector<f64, D>,
        q: SVector<usize, D>,
    ) -> Result<Self> {
        let (q_min_dim, q_min) = q.argmin();
        if q_min < 2 {
            return Err(Error::MinValue {
                vector: "q",
                dim: q_min_dim,
                value: q_min,
                ge_value: 2,
            });
        }
        let (dim, distance) = (upper - lower).argmin();
        if distance <= 0.0 {
            return Err(Error::MinDistanceBetweenVectors {
                vector1: "lower",
                vector2: "upper",
                dim,
                distance,
                gt_distance: 0.0,
            });
        }

        let q_f = SVector::<f64, D>::from_vec(
            q.iter()
                .map(|v| 1. / (*v as f64 - 1.))
                .collect::<Vec<f64>>(),
        );
        let delta = (upper - lower).component_mul(&q_f);
        let pos = SVector::<usize, D>::zeros();
        let x = SVector::<f64, D>::zeros();
        let points_vec = Grid::build_grid(&lower, &delta, &q, pos, x, 0);
        let points =
            Matrix::<f64, Const<D>, Dyn, VecStorage<f64, Const<D>, Dyn>>::from_columns(&points_vec);
        Ok(Self {
            lower,
            upper,
            q,
            points,
        })
    }

    fn build_grid(
        lower: &SVector<f64, D>,
        delta: &SVector<f64, D>,
        q: &SVector<usize, D>,
        mut pos: SVector<usize, D>,
        mut x: SVector<f64, D>,
        d: usize,
    ) -> Vec<SVector<f64, D>> {
        if d < lower.len() {
            let mut vec: Vec<SVector<f64, D>> = vec![];
            for i in 0..q[d] {
                x[d] = lower[d] + i as f64 * delta[d];
                pos[d] = i;
                vec.extend(Grid::build_grid(lower, delta, q, pos, x, d + 1));
            }
            vec
        } else {
            vec![x]
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::{Error, Grid, MatrixDRows, Result};
    use nalgebra::Vector2;

    #[test]
    fn grid() -> Result<()> {
        let lower = Vector2::new(0., 0.);
        let upper = Vector2::new(1., 1.);
        let q = Vector2::new(2, 2);
        let grid = Grid::new(lower, upper, q)?;

        let grid_rslt: MatrixDRows<2> = MatrixDRows::from_vec(vec![0., 0., 0., 1., 1., 0., 1., 1.]);
        assert_eq!(grid.points, grid_rslt);
        Ok(())
    }

    #[test]
    fn grid_bound() -> Result<()> {
        let lower = Vector2::new(0., 0.);
        let upper = Vector2::new(1., 0.);
        let q = Vector2::new(2, 2);
        let grid = Grid::new(lower, upper, q);

        let grid_err = Err(Error::MinDistanceBetweenVectors {
            vector1: "lower",
            vector2: "upper",
            dim: 1,
            distance: 0.,
            gt_distance: 0.,
        });
        assert_eq!(grid, grid_err);
        Ok(())
    }

    #[test]
    fn grid_sample_size() -> Result<()> {
        let lower = Vector2::new(0., 0.);
        let upper = Vector2::new(1., 1.);
        let q = Vector2::new(2, 1);
        let grid = Grid::new(lower, upper, q);

        let grid_err = Err(Error::MinValue {
            vector: "q",
            dim: 1,
            value: 1,
            ge_value: 2,
        });
        assert_eq!(grid, grid_err);
        Ok(())
    }
}