numrs2 0.3.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

//! Compatibility with the ndarray crate
//!
//! This module provides conversions between NumRS Array and ndarray Array
//! structures, allowing for interoperability between the two libraries.

use crate::array::Array;
use crate::error::{NumRs2Error, Result};
use num_traits::NumCast;
use scirs2_core::ndarray::{Array as NdArray, ArrayD, Dimension, IxDyn};
use std::fmt::Debug;

/// Convert from scirs2_core::ndarray::Array to NumRS Array
///
/// # Arguments
///
/// * `ndarr` - ndarray Array to convert
///
/// # Returns
///
/// A NumRS Array containing the same data as the input ndarray Array
///
/// # Example
///
/// ```
/// use numrs2::prelude::*;
/// use scirs2_core::ndarray::{Array as NdArray, IxDyn};
/// use numrs2::interop::ndarray_compat::from_ndarray;
///
/// // Create a 2D ndarray
/// let nd_arr = NdArray::from_shape_vec(IxDyn(&[2, 3]), vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0])
///     .expect("Failed to create ndarray from shape and vec");
///
/// // Convert to NumRS Array
/// let num_arr = from_ndarray(&nd_arr).expect("Failed to convert from ndarray");
///
/// assert_eq!(num_arr.shape(), vec![2, 3]);
/// assert_eq!(num_arr.to_vec(), vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]);
/// ```
pub fn from_ndarray<T, D>(ndarr: &NdArray<T, D>) -> Result<Array<T>>
where
    T: Clone + Debug + NumCast,
    D: Dimension,
{
    // Convert shape
    let shape: Vec<usize> = ndarr.shape().to_vec();

    // Convert data
    let data: Vec<T> = ndarr.iter().cloned().collect();

    // Create NumRS Array
    let arr = Array::from_vec(data);
    Ok(arr.reshape(&shape))
}

/// Convert from NumRS Array to scirs2_core::ndarray::Array
///
/// # Arguments
///
/// * `arr` - NumRS Array to convert
///
/// # Returns
///
/// An ndarray Array containing the same data as the input NumRS Array
///
/// # Example
///
/// ```
/// use numrs2::prelude::*;
/// use scirs2_core::ndarray::{Array as NdArray, IxDyn};
/// use numrs2::interop::ndarray_compat::to_ndarray;
///
/// // Create a 2D NumRS Array
/// let num_arr = Array::from_vec(vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]).reshape(&[2, 3]);
///
/// // Convert to ndarray
/// let nd_arr = to_ndarray(&num_arr).expect("Failed to convert to ndarray");
///
/// assert_eq!(nd_arr.shape(), &[2, 3]);
/// assert_eq!(nd_arr.as_slice().expect("Failed to get slice from ndarray"), &[1.0, 2.0, 3.0, 4.0, 5.0, 6.0]);
/// ```
pub fn to_ndarray<T>(arr: &Array<T>) -> Result<ArrayD<T>>
where
    T: Clone + Debug,
{
    // Convert shape
    let shape: Vec<usize> = arr.shape();

    // Convert data
    let data = arr.to_vec();

    // Create ndarray Array
    NdArray::from_shape_vec(IxDyn(&shape), data)
        .map_err(|e| NumRs2Error::ConversionError(format!("Failed to convert to ndarray: {}", e)))
}

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

    #[test]
    fn test_from_ndarray_2d() {
        // Create a 2D ndarray
        let nd_arr = Array2::from_shape_vec((2, 3), vec![1, 2, 3, 4, 5, 6])
            .expect("Failed to create ndarray from shape and vec");

        // Convert to NumRS Array
        let num_arr = from_ndarray(&nd_arr).expect("Failed to convert from ndarray");

        assert_eq!(num_arr.shape(), vec![2, 3]);
        assert_eq!(num_arr.to_vec(), vec![1, 2, 3, 4, 5, 6]);
    }

    #[test]
    fn test_to_ndarray_2d() {
        // Create a 2D NumRS Array
        let num_arr = Array::from_vec(vec![1, 2, 3, 4, 5, 6]).reshape(&[2, 3]);

        // Convert to ndarray
        let nd_arr = to_ndarray(&num_arr).expect("Failed to convert to ndarray");

        assert_eq!(nd_arr.shape(), &[2, 3]);
        assert_eq!(
            nd_arr.as_slice().expect("Failed to get slice from ndarray"),
            &[1, 2, 3, 4, 5, 6]
        );
    }

    #[test]
    fn test_round_trip_conversion() {
        // Create a NumRS Array
        let original = Array::from_vec(vec![1.0, 2.0, 3.0, 4.0]).reshape(&[2, 2]);

        // Convert to ndarray and back
        let nd_arr = to_ndarray(&original).expect("Failed to convert to ndarray");
        let round_trip = from_ndarray(&nd_arr).expect("Failed to convert from ndarray");

        assert_eq!(original.shape(), round_trip.shape());
        assert_eq!(original.to_vec(), round_trip.to_vec());
    }
}