rhai-sci 0.4.0

Scientific computing in the Rhai scripting language
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247

#![cfg(feature = "nalgebra")]

use rhai::{Array, Dynamic, EvalAltResult, FLOAT, INT};
use rhai_sci::matrix::RhaiMatrix;
use rhai_sci::matrix_functions::{
    horzcat, matrix_size_by_reference, meshgrid, repmat, transpose, vertcat,
};
use rhai_sci::validation_functions::{is_column_vector, is_row_vector};

#[test]
fn transpose_orients_row_vector() {
    let data: Array = vec![
        Dynamic::from_int(1),
        Dynamic::from_int(2),
        Dynamic::from_int(3),
    ];
    let row = RhaiMatrix::row_vector(data);
    let mut result = transpose(row).unwrap().to_array();
    assert!(is_column_vector(&mut result));
}

#[test]
fn transpose_orients_column_vector() {
    let data: Array = vec![
        Dynamic::from_int(1),
        Dynamic::from_int(2),
        Dynamic::from_int(3),
    ];
    let column = RhaiMatrix::column_vector(data);
    let mut result = transpose(column).unwrap().to_array();
    assert!(is_row_vector(&mut result));

    let row = result[0].clone().into_array().unwrap();
    let values: Vec<FLOAT> = row.into_iter().map(|d| d.as_float().unwrap()).collect();
    assert_eq!(values, vec![1.0, 2.0, 3.0]);
}

#[test]
fn horzcat_concatenates_rows() {
    let a: Array = vec![Dynamic::from_int(1), Dynamic::from_int(2)];
    let b: Array = vec![Dynamic::from_int(3), Dynamic::from_int(4)];
    let m1 = RhaiMatrix::row_vector(a);
    let m2 = RhaiMatrix::row_vector(b);
    let mut result = horzcat(m1, m2).unwrap().to_array();
    assert!(is_row_vector(&mut result));
    let row = result[0].clone().into_array().unwrap();
    let values: Vec<FLOAT> = row.into_iter().map(|d| d.as_float().unwrap()).collect();
    assert_eq!(values, vec![1.0, 2.0, 3.0, 4.0]);
}

#[test]
fn horzcat_column_vectors_result_in_matrix_with_two_columns() {
    let a = RhaiMatrix::column_vector(vec![Dynamic::from_int(1), Dynamic::from_int(2)]);
    let b = RhaiMatrix::column_vector(vec![Dynamic::from_int(3), Dynamic::from_int(4)]);
    let mut result = horzcat(a, b).unwrap().to_array();
    let shape = matrix_size_by_reference(&mut result);
    let dims: Vec<INT> = shape.into_iter().map(|d| d.as_int().unwrap()).collect();
    assert_eq!(dims, vec![2, 2]);
}

#[test]
fn horzcat_mixed_shapes_error_out() {
    let row = RhaiMatrix::row_vector(vec![Dynamic::from_int(1), Dynamic::from_int(2)]);
    let column = RhaiMatrix::column_vector(vec![Dynamic::from_int(3), Dynamic::from_int(4)]);
    let err = horzcat(row, column).unwrap_err();
    match err.as_ref() {
        EvalAltResult::ErrorArithmetic(message, _) => {
            assert!(message.contains("same number of rows"));
        }
        other => panic!("unexpected error: {:?}", other),
    }
}

#[test]
fn vertcat_concatenates_columns() {
    let a: Array = vec![
        Dynamic::from_array(vec![Dynamic::from_int(1)]),
        Dynamic::from_array(vec![Dynamic::from_int(2)]),
    ];
    let b: Array = vec![
        Dynamic::from_array(vec![Dynamic::from_int(3)]),
        Dynamic::from_array(vec![Dynamic::from_int(4)]),
    ];
    let m1 = RhaiMatrix::from_array(a);
    let m2 = RhaiMatrix::from_array(b);
    let mut result = vertcat(m1, m2).unwrap().to_array();
    assert!(is_column_vector(&mut result));
}

#[test]
fn vertcat_row_vectors_result_in_matrix_with_two_rows() {
    let m1 = RhaiMatrix::row_vector(vec![Dynamic::from_int(1), Dynamic::from_int(2)]);
    let m2 = RhaiMatrix::row_vector(vec![Dynamic::from_int(3), Dynamic::from_int(4)]);
    let mut result = vertcat(m1, m2).unwrap().to_array();
    let shape = matrix_size_by_reference(&mut result);
    let dims: Vec<INT> = shape.into_iter().map(|d| d.as_int().unwrap()).collect();
    assert_eq!(dims, vec![2, 2]);
}

#[test]
fn vertcat_mixed_shapes_error_out() {
    let column = RhaiMatrix::column_vector(vec![Dynamic::from_int(1), Dynamic::from_int(2)]);
    let row = RhaiMatrix::row_vector(vec![Dynamic::from_int(3), Dynamic::from_int(4)]);
    let err = vertcat(column, row).unwrap_err();
    match err.as_ref() {
        EvalAltResult::ErrorArithmetic(message, _) => {
            assert!(message.contains("same number of columns"));
        }
        other => panic!("unexpected error: {:?}", other),
    }
}

#[test]
fn repmat_replicates_matrix() {
    let data: Array = vec![
        Dynamic::from_array(vec![Dynamic::from_int(1), Dynamic::from_int(2)]),
        Dynamic::from_array(vec![Dynamic::from_int(3), Dynamic::from_int(4)]),
    ];
    let m = RhaiMatrix::from_array(data);
    let mut result = repmat(m, 2, 2).unwrap().to_array();
    let shape = matrix_size_by_reference(&mut result);
    let dims: Vec<INT> = shape.into_iter().map(|d| d.as_int().unwrap()).collect();
    assert_eq!(dims, vec![4, 4]);
}

#[test]
fn meshgrid_matches_matlab_shape_for_mismatched_lengths() {
    let x: Array = vec![
        Dynamic::from_int(1),
        Dynamic::from_int(2),
        Dynamic::from_int(3),
    ];
    let y: Array = vec![Dynamic::from_int(4), Dynamic::from_int(5)];
    let grid = meshgrid(x.clone(), y.clone()).unwrap();

    let x_grid = grid.get("x").unwrap().clone().into_array().unwrap();
    let y_grid = grid.get("y").unwrap().clone().into_array().unwrap();

    let mut x_grid_for_size = x_grid.clone();
    let x_shape = matrix_size_by_reference(&mut x_grid_for_size);
    let x_dims: Vec<INT> = x_shape.into_iter().map(|d| d.as_int().unwrap()).collect();
    assert_eq!(x_dims, vec![2, 3]);

    let mut y_grid_for_size = y_grid.clone();
    let y_shape = matrix_size_by_reference(&mut y_grid_for_size);
    let y_dims: Vec<INT> = y_shape.into_iter().map(|d| d.as_int().unwrap()).collect();
    assert_eq!(y_dims, vec![2, 3]);

    for row in x_grid.into_iter() {
        let row_values: Vec<INT> = row
            .into_array()
            .unwrap()
            .into_iter()
            .map(|d| d.as_int().unwrap())
            .collect();
        assert_eq!(row_values, vec![1, 2, 3]);
    }

    let y_rows: Vec<Vec<INT>> = y_grid
        .into_iter()
        .map(|row| {
            row.into_array()
                .unwrap()
                .into_iter()
                .map(|d| d.as_int().unwrap())
                .collect()
        })
        .collect();
    assert_eq!(y_rows, vec![vec![4, 4, 4], vec![5, 5, 5]]);
}

#[test]
fn meshgrid_accepts_row_vector_input() {
    let row: Array = vec![Dynamic::from_array(vec![
        Dynamic::from_int(0),
        Dynamic::from_int(1),
        Dynamic::from_int(2),
    ])];
    let y: Array = vec![Dynamic::from_int(3), Dynamic::from_int(4)];

    let grid = meshgrid(row, y).unwrap();

    let x_grid = grid.get("x").unwrap().clone().into_array().unwrap();
    let y_grid = grid.get("y").unwrap().clone().into_array().unwrap();

    for row in x_grid.into_iter() {
        let values: Vec<INT> = row
            .into_array()
            .unwrap()
            .into_iter()
            .map(|d| d.as_int().unwrap())
            .collect();
        assert_eq!(values, vec![0, 1, 2]);
    }

    let y_rows: Vec<Vec<INT>> = y_grid
        .into_iter()
        .map(|row| {
            row.into_array()
                .unwrap()
                .into_iter()
                .map(|d| d.as_int().unwrap())
                .collect()
        })
        .collect();
    assert_eq!(y_rows, vec![vec![3, 3, 3], vec![4, 4, 4]]);
}

#[test]
fn meshgrid_accepts_column_vector_inputs() {
    let column_x: Array = vec![
        Dynamic::from_array(vec![Dynamic::from_int(0)]),
        Dynamic::from_array(vec![Dynamic::from_int(1)]),
        Dynamic::from_array(vec![Dynamic::from_int(2)]),
    ];
    let column_y: Array = vec![
        Dynamic::from_array(vec![Dynamic::from_int(3)]),
        Dynamic::from_array(vec![Dynamic::from_int(4)]),
    ];

    let grid = meshgrid(column_x, column_y).unwrap();

    let x_grid = grid.get("x").unwrap().clone().into_array().unwrap();
    let y_grid = grid.get("y").unwrap().clone().into_array().unwrap();

    for row in x_grid.into_iter() {
        let values: Vec<INT> = row
            .into_array()
            .unwrap()
            .into_iter()
            .map(|d| d.as_int().unwrap())
            .collect();
        assert_eq!(values, vec![0, 1, 2]);
    }

    let y_rows: Vec<Vec<INT>> = y_grid
        .into_iter()
        .map(|row| {
            row.into_array()
                .unwrap()
                .into_iter()
                .map(|d| d.as_int().unwrap())
                .collect()
        })
        .collect();
    assert_eq!(y_rows, vec![vec![3, 3, 3], vec![4, 4, 4]]);
}