numrs2 0.3.3

A Rust implementation inspired by NumPy for numerical computing (NumRS2)
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
//! WebAssembly bindings for NumRS2 Array operations
//!
//! This module provides JavaScript-friendly wrappers for NumRS2's core Array type.

use crate::array::Array;
use crate::error::Result as NumRs2Result;
use crate::stats::Statistics;
use wasm_bindgen::prelude::*;

/// WebAssembly wrapper for NumRS2 Array
///
/// This struct provides JavaScript-friendly bindings for NumRS2's Array type.
/// All operations return Results and avoid unwrap() calls for robust error handling.
#[wasm_bindgen]
pub struct WasmArray {
    inner: Array<f64>,
}

#[wasm_bindgen]
impl WasmArray {
    /// Create a new array filled with zeros
    ///
    /// # Parameters
    /// - `shape`: Array shape as a JavaScript array of numbers
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.zeros([2, 3]);
    /// console.log(arr.shape()); // [2, 3]
    /// ```
    #[wasm_bindgen]
    pub fn zeros(shape: &[usize]) -> WasmArray {
        WasmArray {
            inner: Array::zeros(shape),
        }
    }

    /// Create a new array filled with ones
    ///
    /// # Parameters
    /// - `shape`: Array shape as a JavaScript array of numbers
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.ones([2, 3]);
    /// ```
    #[wasm_bindgen]
    pub fn ones(shape: &[usize]) -> WasmArray {
        WasmArray {
            inner: Array::ones(shape),
        }
    }

    /// Create a new array filled with a constant value
    ///
    /// # Parameters
    /// - `shape`: Array shape as a JavaScript array of numbers
    /// - `value`: Fill value
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.full([2, 3], 5.0);
    /// ```
    #[wasm_bindgen]
    pub fn full(shape: &[usize], value: f64) -> WasmArray {
        WasmArray {
            inner: Array::full(shape, value),
        }
    }

    /// Create array from a flat JavaScript array with shape
    ///
    /// # Parameters
    /// - `data`: Flat array of values
    /// - `shape`: Array shape
    ///
    /// # Returns
    /// Result containing WasmArray or error message
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.from_vec([1, 2, 3, 4, 5, 6], [2, 3]);
    /// ```
    #[wasm_bindgen]
    pub fn from_vec(data: &[f64], shape: &[usize]) -> Result<WasmArray, JsValue> {
        let total_size: usize = shape.iter().product();
        if data.len() != total_size {
            return Err(JsValue::from_str(&format!(
                "Data length {} does not match shape product {}",
                data.len(),
                total_size
            )));
        }

        Ok(WasmArray {
            inner: Array::from_vec(data.to_vec()).reshape(shape),
        })
    }

    /// Get the shape of the array
    ///
    /// # Returns
    /// JavaScript array containing the shape dimensions
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.zeros([2, 3]);
    /// console.log(arr.shape()); // [2, 3]
    /// ```
    #[wasm_bindgen]
    pub fn shape(&self) -> Vec<usize> {
        self.inner.shape()
    }

    /// Get the number of dimensions
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.zeros([2, 3]);
    /// console.log(arr.ndim()); // 2
    /// ```
    #[wasm_bindgen]
    pub fn ndim(&self) -> usize {
        self.inner.ndim()
    }

    /// Get the total number of elements
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.zeros([2, 3]);
    /// console.log(arr.size()); // 6
    /// ```
    #[wasm_bindgen]
    pub fn size(&self) -> usize {
        self.inner.size()
    }

    /// Reshape the array to a new shape
    ///
    /// # Parameters
    /// - `new_shape`: New shape as JavaScript array
    ///
    /// # Returns
    /// Result containing reshaped WasmArray or error
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.zeros([2, 3]);
    /// const reshaped = arr.reshape([3, 2]);
    /// ```
    #[wasm_bindgen]
    pub fn reshape(&self, new_shape: &[usize]) -> Result<WasmArray, JsValue> {
        let new_size: usize = new_shape.iter().product();
        if new_size != self.inner.size() {
            return Err(JsValue::from_str(&format!(
                "Cannot reshape array of size {} into shape with size {}",
                self.inner.size(),
                new_size
            )));
        }

        Ok(WasmArray {
            inner: self.inner.reshape(new_shape),
        })
    }

    /// Transpose the array
    ///
    /// # Returns
    /// New WasmArray with transposed dimensions
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.zeros([2, 3]);
    /// const t = arr.transpose();
    /// console.log(t.shape()); // [3, 2]
    /// ```
    #[wasm_bindgen]
    pub fn transpose(&self) -> WasmArray {
        WasmArray {
            inner: self.inner.transpose(),
        }
    }

    /// Get element at specified indices
    ///
    /// # Parameters
    /// - `indices`: Array indices as JavaScript array
    ///
    /// # Returns
    /// Result containing the value or error
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.full([2, 3], 5.0);
    /// const val = arr.get([0, 1]); // 5.0
    /// ```
    #[wasm_bindgen]
    pub fn get(&self, indices: &[usize]) -> Result<f64, JsValue> {
        self.inner
            .get(indices)
            .map_err(|e| JsValue::from_str(&format!("Get error: {}", e)))
    }

    /// Set element at specified indices
    ///
    /// # Parameters
    /// - `indices`: Array indices as JavaScript array
    /// - `value`: Value to set
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.zeros([2, 3]);
    /// arr.set([0, 1], 5.0);
    /// ```
    #[wasm_bindgen]
    pub fn set(&mut self, indices: &[usize], value: f64) -> Result<(), JsValue> {
        self.inner
            .set(indices, value)
            .map_err(|e| JsValue::from_str(&format!("Set error: {}", e)))
    }

    /// Convert array to flat JavaScript array
    ///
    /// # Returns
    /// Flat array of all elements in row-major order
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.full([2, 3], 5.0);
    /// const data = arr.to_vec(); // [5, 5, 5, 5, 5, 5]
    /// ```
    #[wasm_bindgen]
    pub fn to_vec(&self) -> Vec<f64> {
        self.inner.to_vec()
    }

    /// Element-wise addition
    ///
    /// # Parameters
    /// - `other`: Another WasmArray
    ///
    /// # Returns
    /// Result containing sum array or error
    ///
    /// # Example
    /// ```javascript
    /// const a = WasmArray.ones([2, 3]);
    /// const b = WasmArray.ones([2, 3]);
    /// const c = a.add(b);
    /// ```
    #[wasm_bindgen]
    pub fn add(&self, other: &WasmArray) -> Result<WasmArray, JsValue> {
        if self.inner.shape() != other.inner.shape() {
            return Err(JsValue::from_str("Arrays must have the same shape"));
        }

        Ok(WasmArray {
            inner: self.inner.add(&other.inner),
        })
    }

    /// Element-wise subtraction
    ///
    /// # Parameters
    /// - `other`: Another WasmArray
    ///
    /// # Returns
    /// Result containing difference array or error
    #[wasm_bindgen]
    pub fn subtract(&self, other: &WasmArray) -> Result<WasmArray, JsValue> {
        if self.inner.shape() != other.inner.shape() {
            return Err(JsValue::from_str("Arrays must have the same shape"));
        }

        Ok(WasmArray {
            inner: self.inner.subtract(&other.inner),
        })
    }

    /// Element-wise multiplication
    ///
    /// # Parameters
    /// - `other`: Another WasmArray
    ///
    /// # Returns
    /// Result containing product array or error
    #[wasm_bindgen]
    pub fn multiply(&self, other: &WasmArray) -> Result<WasmArray, JsValue> {
        if self.inner.shape() != other.inner.shape() {
            return Err(JsValue::from_str("Arrays must have the same shape"));
        }

        Ok(WasmArray {
            inner: self.inner.multiply(&other.inner),
        })
    }

    /// Element-wise division
    ///
    /// # Parameters
    /// - `other`: Another WasmArray
    ///
    /// # Returns
    /// Result containing quotient array or error
    #[wasm_bindgen]
    pub fn divide(&self, other: &WasmArray) -> Result<WasmArray, JsValue> {
        if self.inner.shape() != other.inner.shape() {
            return Err(JsValue::from_str("Arrays must have the same shape"));
        }

        Ok(WasmArray {
            inner: self.inner.divide(&other.inner),
        })
    }

    /// Add a scalar value to all elements
    ///
    /// # Parameters
    /// - `scalar`: Scalar value to add
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.ones([2, 3]);
    /// const result = arr.add_scalar(5.0);
    /// ```
    #[wasm_bindgen]
    pub fn add_scalar(&self, scalar: f64) -> WasmArray {
        WasmArray {
            inner: self.inner.add_scalar(scalar),
        }
    }

    /// Multiply all elements by a scalar value
    ///
    /// # Parameters
    /// - `scalar`: Scalar value to multiply by
    #[wasm_bindgen]
    pub fn multiply_scalar(&self, scalar: f64) -> WasmArray {
        WasmArray {
            inner: self.inner.multiply_scalar(scalar),
        }
    }

    /// Compute the sum of all elements
    ///
    /// # Returns
    /// Sum of all array elements
    ///
    /// # Example
    /// ```javascript
    /// const arr = WasmArray.full([2, 3], 5.0);
    /// console.log(arr.sum()); // 30.0
    /// ```
    #[wasm_bindgen]
    pub fn sum(&self) -> f64 {
        self.inner.sum()
    }

    /// Compute the mean of all elements
    ///
    /// # Returns
    /// Mean of all array elements
    #[wasm_bindgen]
    pub fn mean(&self) -> f64 {
        self.inner.mean()
    }

    /// Compute the minimum element value
    ///
    /// # Returns
    /// Minimum value in the array
    #[wasm_bindgen]
    pub fn min(&self) -> f64 {
        self.inner.min()
    }

    /// Compute the maximum element value
    ///
    /// # Returns
    /// Maximum value in the array
    #[wasm_bindgen]
    pub fn max(&self) -> f64 {
        self.inner.max()
    }
}

// Helper implementation for WasmArray - provides internal methods
impl WasmArray {
    /// Create a WasmArray from an Array
    ///
    /// # Parameters
    /// - `array`: The Array to wrap
    ///
    /// # Returns
    /// A new WasmArray wrapping the given Array
    pub(crate) fn from_array(array: Array<f64>) -> WasmArray {
        WasmArray { inner: array }
    }

    /// Consume this WasmArray and return the inner Array
    ///
    /// # Returns
    /// The contained Array<f64>
    pub(crate) fn into_inner(self) -> Array<f64> {
        self.inner
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_zeros() {
        let arr = WasmArray::zeros(&[2, 3]);
        assert_eq!(arr.shape(), vec![2, 3]);
        assert_eq!(arr.size(), 6);
    }

    #[test]
    fn test_ones() {
        let arr = WasmArray::ones(&[2, 3]);
        assert_eq!(arr.sum(), 6.0);
    }

    #[test]
    fn test_from_vec() {
        let data = vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0];
        let arr = WasmArray::from_vec(&data, &[2, 3]).expect("from_vec should succeed");
        assert_eq!(arr.shape(), vec![2, 3]);
        assert_eq!(arr.to_vec(), data);
    }

    #[test]
    fn test_reshape() {
        let arr = WasmArray::zeros(&[2, 3]);
        let reshaped = arr.reshape(&[3, 2]).expect("reshape should succeed");
        assert_eq!(reshaped.shape(), vec![3, 2]);
    }

    #[test]
    fn test_transpose() {
        let arr = WasmArray::zeros(&[2, 3]);
        let t = arr.transpose();
        assert_eq!(t.shape(), vec![3, 2]);
    }

    #[test]
    fn test_arithmetic() {
        let a = WasmArray::ones(&[2, 3]);
        let b = WasmArray::full(&[2, 3], 2.0);

        let sum = a.add(&b).expect("add should succeed");
        assert_eq!(sum.sum(), 18.0); // (1 + 2) * 6 = 18

        let diff = b.subtract(&a).expect("subtract should succeed");
        assert_eq!(diff.sum(), 6.0); // (2 - 1) * 6 = 6

        let prod = a.multiply(&b).expect("multiply should succeed");
        assert_eq!(prod.sum(), 12.0); // (1 * 2) * 6 = 12

        let quot = b.divide(&a).expect("divide should succeed");
        assert_eq!(quot.sum(), 12.0); // (2 / 1) * 6 = 12
    }

    #[test]
    fn test_scalar_ops() {
        let arr = WasmArray::ones(&[2, 3]);
        let added = arr.add_scalar(5.0);
        assert_eq!(added.sum(), 36.0); // (1 + 5) * 6 = 36

        let scaled = arr.multiply_scalar(3.0);
        assert_eq!(scaled.sum(), 18.0); // (1 * 3) * 6 = 18
    }
}