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

# NumRS2 Interoperability Module

This directory contains modules for integrating NumRS2 with other Rust numerical computing libraries.

## Current Integrations

- `ndarray_compat.rs`: Integration with ndarray
- `nalgebra_compat.rs`: Integration with nalgebra
- `scirs_compat.rs`: Integration with SciRS2 (in progress)

## SciRS2 Integration Status

The SciRS2 integration uses the correct module paths. The implementation provides adapter functions for advanced statistical distributions from SciRS2.

### Current Features

1. **Module Paths**: The imports in `scirs_compat.rs` match the SciRS2 module structure:
   - `scirs2_stats::distributions::continuous` for most continuous distributions
   - `scirs2_core::array::Array` for array types
   - `scirs2_core::random::Generator` for random generators

2. **Distribution Implementations**: The following distributions have been implemented:
   - Noncentral Chi-Square (`NoncentralChiSquared`)
   - Noncentral F (`FNoncentral`)
   - Von Mises (`VonMises`)
   - Maxwell-Boltzmann (`MaxwellBoltzmann`)
   - Truncated Normal (`TruncatedNormal`)
   - Multivariate Normal with Rotation (`MultivariateNormal`)

3. **Comprehensive Tests**: Each distribution has been tested to ensure it produces statistically valid outputs.

### Remaining Tasks

1. **Type Conversions**: The conversion functions between NumRS2 and SciRS2 arrays have been implemented but need more extensive testing.

2. **Additional Distributions**: More distributions from SciRS2 could be added in the future.

3. **Performance Optimization**: Further optimization of the conversion between NumRS2 and SciRS2 arrays could improve performance.

4. **Run Integration Tests**: After the implementation is complete, run the full integration tests in `tests/test_scirs_integration.rs`.

### Resources

- SciRS2 Core: https://crates.io/crates/scirs2-core
- SciRS2 Stats: https://crates.io/crates/scirs2-stats
- SciRS2 Documentation: https://docs.rs/scirs2-core

## Usage

To use the SciRS2 integration, add the following to your `Cargo.toml`:

```toml
[dependencies]
numrs2 = { version = "0.1.1", features = ["scirs"] }
```

Then import the SciRS2 compatibility module:

```rust
use numrs2::interop::scirs_compat::*;
```

See the examples in `/examples/random_distributions_example.rs` for usage examples.