numrs2 0.4.0

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
//! Statistics operations for Python bindings

use crate::array::Array;
use crate::axis_ops::AxisOps;
use crate::python::array::PyArray;
use pyo3::exceptions::PyValueError;
use pyo3::prelude::*;
use std::cmp::Ordering;

/// Compute the mean of array elements
///
/// When `axis` is None, returns a scalar f64.
/// When `axis` is Some(ax), reduces along that axis and returns a PyArray.
#[pyfunction]
fn mean(py: Python<'_>, a: &PyArray, axis: Option<usize>) -> PyResult<Py<PyAny>> {
    match axis {
        None => {
            let v = a.mean();
            Ok(v.into_pyobject(py)?.into_any().unbind())
        }
        Some(ax) => {
            let result = a
                .inner
                .mean_axis(Some(ax))
                .map_err(|e| PyValueError::new_err(e.to_string()))?;
            let py_arr = PyArray { inner: result };
            py_arr.into_pyobject(py).map(|b| b.into_any().unbind())
        }
    }
}

/// Compute the median of array elements
///
/// When `axis` is None, returns a scalar f64.
/// When `axis` is Some(ax), sorts each 1-D slice along that axis and returns the median
/// for each slice as a PyArray.
#[pyfunction]
fn median(py: Python<'_>, a: &PyArray, axis: Option<usize>) -> PyResult<Py<PyAny>> {
    match axis {
        None => {
            let mut data = a.tolist();
            if data.is_empty() {
                return Err(PyValueError::new_err(
                    "Cannot compute median of empty array",
                ));
            }
            data.sort_by(|x: &f64, y: &f64| x.partial_cmp(y).unwrap_or(Ordering::Equal));
            let len = data.len();
            let v = if len.is_multiple_of(2) {
                (data[len / 2 - 1] + data[len / 2]) / 2.0
            } else {
                data[len / 2]
            };
            Ok(v.into_pyobject(py)?.into_any().unbind())
        }
        Some(ax) => {
            let shape = a.inner.shape();
            let ndim = a.inner.ndim();
            if ax >= ndim {
                return Err(PyValueError::new_err(format!(
                    "Axis {} out of bounds for array of dimension {}",
                    ax, ndim
                )));
            }
            let axis_len = shape[ax];
            if axis_len == 0 {
                return Err(PyValueError::new_err("Cannot compute median of empty axis"));
            }

            // Build output shape (input shape with axis `ax` removed)
            let mut out_shape = shape.clone();
            out_shape.remove(ax);
            let out_size: usize = out_shape.iter().product::<usize>().max(1);

            let data = a.inner.to_vec();
            let mut result = vec![0.0_f64; out_size];

            for out_i in 0..out_size {
                // Reconstruct multi-dim output index
                let mut out_idx = vec![0usize; out_shape.len()];
                let mut tmp = out_i;
                for d in (0..out_shape.len()).rev() {
                    out_idx[d] = tmp % out_shape[d];
                    tmp /= out_shape[d];
                }

                // Collect values along `ax`
                let mut slice = Vec::with_capacity(axis_len);
                for j in 0..axis_len {
                    // Build full index
                    let mut full_idx = out_idx.clone();
                    full_idx.insert(ax, j);

                    // Compute linear index
                    let mut linear = 0usize;
                    let mut stride = 1usize;
                    for d in (0..shape.len()).rev() {
                        linear += full_idx[d] * stride;
                        stride *= shape[d];
                    }
                    slice.push(data[linear]);
                }

                slice.sort_by(|x, y| x.partial_cmp(y).unwrap_or(Ordering::Equal));
                let n = slice.len();
                result[out_i] = if n.is_multiple_of(2) {
                    (slice[n / 2 - 1] + slice[n / 2]) / 2.0
                } else {
                    slice[n / 2]
                };
            }

            let arr = Array::from_vec(result).reshape(&out_shape);
            let py_arr = PyArray { inner: arr };
            py_arr.into_pyobject(py).map(|b| b.into_any().unbind())
        }
    }
}

/// Compute the standard deviation
///
/// When `axis` is None, returns a scalar f64.
/// When `axis` is Some(ax), reduces along that axis returning a PyArray.
/// `ddof` controls the degrees-of-freedom correction (default 0).
#[pyfunction]
#[pyo3(name = "std")]
fn stddev(
    py: Python<'_>,
    a: &PyArray,
    axis: Option<usize>,
    ddof: Option<usize>,
) -> PyResult<Py<PyAny>> {
    let ddof_val = ddof.unwrap_or(0);
    match axis {
        None => {
            let data = a.tolist();
            let n = data.len();
            if n <= ddof_val {
                return Err(PyValueError::new_err("Sample size is too small"));
            }
            let mean = data.iter().sum::<f64>() / n as f64;
            let variance =
                data.iter().map(|x| (x - mean).powi(2)).sum::<f64>() / (n - ddof_val) as f64;
            Ok(variance.sqrt().into_pyobject(py)?.into_any().unbind())
        }
        Some(ax) => {
            // Use var_axis (population variance = ddof 0) then scale for ddof
            let var_arr = a
                .inner
                .var_axis(Some(ax))
                .map_err(|e| PyValueError::new_err(e.to_string()))?;

            // var_axis uses ddof=0 (divides by n). Scale to requested ddof.
            let axis_n = a.inner.shape()[ax];
            if axis_n <= ddof_val {
                return Err(PyValueError::new_err("Sample size is too small"));
            }
            let scale = axis_n as f64 / (axis_n - ddof_val) as f64;
            let scaled = var_arr.map(|v| (v * scale).sqrt());
            let py_arr = PyArray { inner: scaled };
            py_arr.into_pyobject(py).map(|b| b.into_any().unbind())
        }
    }
}

/// Compute the variance
///
/// When `axis` is None, returns a scalar f64.
/// When `axis` is Some(ax), reduces along that axis returning a PyArray.
/// `ddof` controls the degrees-of-freedom correction (default 0).
#[pyfunction]
fn var(
    py: Python<'_>,
    a: &PyArray,
    axis: Option<usize>,
    ddof: Option<usize>,
) -> PyResult<Py<PyAny>> {
    let ddof_val = ddof.unwrap_or(0);
    match axis {
        None => {
            let data = a.tolist();
            let n = data.len();
            if n <= ddof_val {
                return Err(PyValueError::new_err("Sample size is too small"));
            }
            let mean = data.iter().sum::<f64>() / n as f64;
            let variance =
                data.iter().map(|x| (x - mean).powi(2)).sum::<f64>() / (n - ddof_val) as f64;
            Ok(variance.into_pyobject(py)?.into_any().unbind())
        }
        Some(ax) => {
            // var_axis uses ddof=0; scale to requested ddof
            let var_arr = a
                .inner
                .var_axis(Some(ax))
                .map_err(|e| PyValueError::new_err(e.to_string()))?;
            let axis_n = a.inner.shape()[ax];
            if axis_n <= ddof_val {
                return Err(PyValueError::new_err("Sample size is too small"));
            }
            let scale = axis_n as f64 / (axis_n - ddof_val) as f64;
            let scaled = var_arr.map(|v| v * scale);
            let py_arr = PyArray { inner: scaled };
            py_arr.into_pyobject(py).map(|b| b.into_any().unbind())
        }
    }
}

/// Compute the correlation coefficient
#[pyfunction]
fn corrcoef(x: &PyArray, y: Option<&PyArray>) -> PyResult<PyArray> {
    if let Some(y_arr) = y {
        let x_data = x.inner.to_vec();
        let y_data = y_arr.inner.to_vec();

        if x_data.len() != y_data.len() {
            return Err(PyValueError::new_err("Arrays must have the same length"));
        }

        if x_data.is_empty() {
            return Err(PyValueError::new_err("Arrays must not be empty"));
        }

        // Compute means
        let mean_x = x_data.iter().sum::<f64>() / x_data.len() as f64;
        let mean_y = y_data.iter().sum::<f64>() / y_data.len() as f64;

        // Compute covariance and standard deviations
        let mut cov = 0.0;
        let mut var_x = 0.0;
        let mut var_y = 0.0;

        for i in 0..x_data.len() {
            let dx = x_data[i] - mean_x;
            let dy = y_data[i] - mean_y;
            cov += dx * dy;
            var_x += dx * dx;
            var_y += dy * dy;
        }

        let std_x = var_x.sqrt();
        let std_y = var_y.sqrt();

        if std_x == 0.0 || std_y == 0.0 {
            return Err(PyValueError::new_err("Standard deviation is zero"));
        }

        let corr = cov / (std_x * std_y);

        // Return 2x2 correlation matrix
        let data = vec![1.0, corr, corr, 1.0];
        Ok(PyArray {
            inner: crate::array::Array::from_vec(data).reshape(&[2, 2]),
        })
    } else {
        Err(PyValueError::new_err(
            "Single array correlation not yet supported",
        ))
    }
}

/// Compute covariance matrix
///
/// Delegates to `crate::stats::correlation::cov` which is fully implemented.
/// `rowvar=true` (default): each row represents a variable.
#[pyfunction]
fn cov(m: &PyArray, rowvar: Option<bool>) -> PyResult<PyArray> {
    let cov_matrix = crate::stats::correlation::cov::<f64>(&m.inner, None, rowvar, None, None)
        .map_err(|e| PyValueError::new_err(e.to_string()))?;
    Ok(PyArray { inner: cov_matrix })
}

/// Compute histogram
#[pyfunction]
fn histogram(
    a: &PyArray,
    bins: Option<usize>,
    range: Option<(f64, f64)>,
) -> PyResult<(PyArray, PyArray)> {
    let bins = bins.unwrap_or(10);
    let data = a.tolist();

    if data.is_empty() {
        return Err(PyValueError::new_err(
            "Cannot compute histogram of empty array",
        ));
    }

    let (min_val, max_val) = if let Some((min, max)) = range {
        (min, max)
    } else {
        let min = data
            .iter()
            .copied()
            .min_by(|a: &f64, b: &f64| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal))
            .ok_or_else(|| PyValueError::new_err("Cannot find minimum"))?;
        let max = data
            .iter()
            .copied()
            .max_by(|a: &f64, b: &f64| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal))
            .ok_or_else(|| PyValueError::new_err("Cannot find maximum"))?;
        (min, max)
    };

    let bin_width = (max_val - min_val) / bins as f64;
    let mut counts = vec![0usize; bins];

    for &value in &data {
        if value >= min_val && value <= max_val {
            let bin_idx = ((value - min_val) / bin_width).floor() as usize;
            let bin_idx = bin_idx.min(bins - 1);
            counts[bin_idx] += 1;
        }
    }

    let edges: Vec<f64> = (0..=bins).map(|i| min_val + i as f64 * bin_width).collect();

    let counts_f64: Vec<f64> = counts.iter().map(|&c| c as f64).collect();

    Ok((
        PyArray {
            inner: crate::array::Array::from_vec(counts_f64),
        },
        PyArray {
            inner: crate::array::Array::from_vec(edges),
        },
    ))
}

/// Compute percentile
#[pyfunction]
fn percentile(a: &PyArray, q: f64) -> PyResult<f64> {
    if !(0.0..=100.0).contains(&q) {
        return Err(PyValueError::new_err(
            "Percentile must be between 0 and 100",
        ));
    }

    let mut data = a.tolist();
    if data.is_empty() {
        return Err(PyValueError::new_err(
            "Cannot compute percentile of empty array",
        ));
    }

    data.sort_by(|a: &f64, b: &f64| a.partial_cmp(b).unwrap_or(Ordering::Equal));

    let index = (q / 100.0) * (data.len() - 1) as f64;
    let lower = index.floor() as usize;
    let upper = index.ceil() as usize;
    let fraction = index - lower as f64;

    Ok(data[lower] + fraction * (data[upper] - data[lower]))
}

/// Generate random samples from normal distribution
#[pyfunction]
fn randn(size: Vec<usize>) -> PyResult<PyArray> {
    use scirs2_core::random::*;

    let total_size: usize = size.iter().product();
    let mut rng = thread_rng();
    let dist = Normal::new(0.0, 1.0).map_err(|e| {
        PyValueError::new_err(format!("Failed to create normal distribution: {}", e))
    })?;

    let data: Vec<f64> = (0..total_size).map(|_| dist.sample(&mut rng)).collect();

    Ok(PyArray {
        inner: crate::array::Array::from_vec(data).reshape(&size),
    })
}

/// Generate random samples from uniform distribution
#[pyfunction]
fn rand(size: Vec<usize>) -> PyResult<PyArray> {
    use scirs2_core::random::*;

    let total_size: usize = size.iter().product();
    let mut rng = thread_rng();

    let data: Vec<f64> = (0..total_size).map(|_| rng.random::<f64>()).collect();

    Ok(PyArray {
        inner: crate::array::Array::from_vec(data).reshape(&size),
    })
}

/// Register statistics functions
pub fn register(m: &Bound<'_, PyModule>) -> PyResult<()> {
    // Create stats submodule
    let stats_module = PyModule::new(m.py(), "stats")?;

    // Add functions
    stats_module.add_function(wrap_pyfunction!(mean, m)?)?;
    stats_module.add_function(wrap_pyfunction!(median, m)?)?;
    stats_module.add_function(wrap_pyfunction!(stddev, m)?)?;
    stats_module.add_function(wrap_pyfunction!(var, m)?)?;
    stats_module.add_function(wrap_pyfunction!(corrcoef, m)?)?;
    stats_module.add_function(wrap_pyfunction!(cov, m)?)?;
    stats_module.add_function(wrap_pyfunction!(histogram, m)?)?;
    stats_module.add_function(wrap_pyfunction!(percentile, m)?)?;

    m.add_submodule(&stats_module)?;

    // Add random module
    let random_module = PyModule::new(m.py(), "random")?;
    random_module.add_function(wrap_pyfunction!(randn, m)?)?;
    random_module.add_function(wrap_pyfunction!(rand, m)?)?;

    m.add_submodule(&random_module)?;

    Ok(())
}