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
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

//! MessagePack serialization support for NumRS2 arrays
//!
//! This module provides pure Rust implementation for serializing and deserializing
//! NumRS2 arrays to/from MessagePack format using rmp-serde.
//!
//! MessagePack is a compact binary serialization format that is more efficient
//! than JSON while maintaining language-agnostic compatibility.
//!
//! # Features
//! - Serialize/deserialize NumRS2 arrays to/from MessagePack
//! - Compact binary format (smaller than JSON)
//! - Type-safe conversions
//! - Shape and metadata preservation
//! - Pure Rust implementation (no C dependencies)
//!
//! # Example
//! ```no_run
//! use numrs2::prelude::*;
//! use numrs2::io::messagepack::{to_messagepack, from_messagepack};
//! use std::path::Path;
//!
//! // Create an array
//! let array = Array::from_vec(vec![1.0, 2.0, 3.0, 4.0]).reshape(&[2, 2]);
//!
//! // Serialize to MessagePack file
//! to_messagepack(&array, Path::new("data.msgpack"))
//!     .expect("Failed to write MessagePack file");
//!
//! // Deserialize from MessagePack file
//! let loaded: Array<f64> = from_messagepack(Path::new("data.msgpack"))
//!     .expect("Failed to read MessagePack file");
//! ```

use crate::array::Array;
use crate::error::{NumRs2Error, Result};
use serde::{Deserialize, Serialize};
use std::fs::File;
use std::io::{BufReader, BufWriter, Read, Write};
use std::path::Path;

/// Internal representation of an Array for MessagePack serialization
#[derive(Serialize, Deserialize)]
struct MessagePackArray<T> {
    /// Shape of the array
    shape: Vec<usize>,
    /// Flattened data
    data: Vec<T>,
    /// Data type name for validation
    dtype: String,
}

/// Serialize a NumRS2 array to MessagePack format and write to file
///
/// # Arguments
/// * `array` - The array to serialize
/// * `path` - Path to the output file
///
/// # Returns
/// * `Ok(())` on success
/// * `Err(NumRs2Error)` if serialization fails
///
/// # Example
/// ```no_run
/// use numrs2::prelude::*;
/// use numrs2::io::messagepack::to_messagepack;
/// use std::path::Path;
///
/// let array = Array::from_vec(vec![1, 2, 3, 4]).reshape(&[2, 2]);
/// to_messagepack(&array, Path::new("output.msgpack"))
///     .expect("Failed to write MessagePack file");
/// ```
pub fn to_messagepack<T, P>(array: &Array<T>, path: P) -> Result<()>
where
    T: Clone + Serialize,
    P: AsRef<Path>,
{
    let file = File::create(path.as_ref())
        .map_err(|e| NumRs2Error::IOError(format!("Failed to create file: {}", e)))?;

    let mut writer = BufWriter::new(file);

    to_messagepack_writer(array, &mut writer)
}

/// Serialize a NumRS2 array to MessagePack format and write to a writer
///
/// # Arguments
/// * `array` - The array to serialize
/// * `writer` - Writer to write the serialized data to
///
/// # Returns
/// * `Ok(())` on success
/// * `Err(NumRs2Error)` if serialization fails
pub fn to_messagepack_writer<T, W>(array: &Array<T>, writer: &mut W) -> Result<()>
where
    T: Clone + Serialize,
    W: Write,
{
    let msgpack_array = MessagePackArray {
        shape: array.shape(),
        data: array.to_vec(),
        dtype: std::any::type_name::<T>().to_string(),
    };

    rmp_serde::encode::write(writer, &msgpack_array).map_err(|e| {
        NumRs2Error::SerializationError(format!("MessagePack serialization error: {}", e))
    })?;

    Ok(())
}

/// Serialize a NumRS2 array to MessagePack bytes
///
/// # Arguments
/// * `array` - The array to serialize
///
/// # Returns
/// * `Ok(Vec<u8>)` containing the serialized bytes
/// * `Err(NumRs2Error)` if serialization fails
///
/// # Example
/// ```no_run
/// use numrs2::prelude::*;
/// use numrs2::io::messagepack::to_messagepack_bytes;
///
/// let array = Array::from_vec(vec![1.0, 2.0, 3.0, 4.0]);
/// let bytes = to_messagepack_bytes(&array)
///     .expect("Failed to serialize to bytes");
/// ```
pub fn to_messagepack_bytes<T>(array: &Array<T>) -> Result<Vec<u8>>
where
    T: Clone + Serialize,
{
    let msgpack_array = MessagePackArray {
        shape: array.shape(),
        data: array.to_vec(),
        dtype: std::any::type_name::<T>().to_string(),
    };

    rmp_serde::to_vec(&msgpack_array).map_err(|e| {
        NumRs2Error::SerializationError(format!("MessagePack serialization error: {}", e))
    })
}

/// Deserialize a NumRS2 array from MessagePack format file
///
/// # Arguments
/// * `path` - Path to the input file
///
/// # Returns
/// * `Ok(Array<T>)` containing the deserialized array
/// * `Err(NumRs2Error)` if deserialization fails
///
/// # Example
/// ```no_run
/// use numrs2::prelude::*;
/// use numrs2::io::messagepack::from_messagepack;
/// use std::path::Path;
///
/// let array: Array<i32> = from_messagepack(Path::new("input.msgpack"))
///     .expect("Failed to read MessagePack file");
/// ```
pub fn from_messagepack<T, P>(path: P) -> Result<Array<T>>
where
    T: Clone + for<'de> Deserialize<'de>,
    P: AsRef<Path>,
{
    let file = File::open(path.as_ref())
        .map_err(|e| NumRs2Error::IOError(format!("Failed to open file: {}", e)))?;

    let mut reader = BufReader::new(file);

    from_messagepack_reader(&mut reader)
}

/// Deserialize a NumRS2 array from MessagePack format reader
///
/// # Arguments
/// * `reader` - Reader to read the serialized data from
///
/// # Returns
/// * `Ok(Array<T>)` containing the deserialized array
/// * `Err(NumRs2Error)` if deserialization fails
pub fn from_messagepack_reader<T, R>(reader: &mut R) -> Result<Array<T>>
where
    T: Clone + for<'de> Deserialize<'de>,
    R: Read,
{
    let msgpack_array: MessagePackArray<T> = rmp_serde::from_read(reader).map_err(|e| {
        NumRs2Error::DeserializationError(format!("MessagePack deserialization error: {}", e))
    })?;

    let array = Array::from_vec(msgpack_array.data).reshape(&msgpack_array.shape);

    Ok(array)
}

/// Deserialize a NumRS2 array from MessagePack bytes
///
/// # Arguments
/// * `bytes` - Byte slice containing MessagePack data
///
/// # Returns
/// * `Ok(Array<T>)` containing the deserialized array
/// * `Err(NumRs2Error)` if deserialization fails
///
/// # Example
/// ```no_run
/// use numrs2::prelude::*;
/// use numrs2::io::messagepack::{to_messagepack_bytes, from_messagepack_bytes};
///
/// let array = Array::from_vec(vec![1.0, 2.0, 3.0, 4.0]);
/// let bytes = to_messagepack_bytes(&array).unwrap();
///
/// let loaded: Array<f64> = from_messagepack_bytes(&bytes)
///     .expect("Failed to deserialize from bytes");
/// ```
pub fn from_messagepack_bytes<T>(bytes: &[u8]) -> Result<Array<T>>
where
    T: Clone + for<'de> Deserialize<'de>,
{
    let msgpack_array: MessagePackArray<T> = rmp_serde::from_slice(bytes).map_err(|e| {
        NumRs2Error::DeserializationError(format!("MessagePack deserialization error: {}", e))
    })?;

    let array = Array::from_vec(msgpack_array.data).reshape(&msgpack_array.shape);

    Ok(array)
}

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

    #[test]
    fn test_messagepack_roundtrip_i32() {
        let array = Array::from_vec(vec![1, 2, 3, 4, 5, 6]).reshape(&[2, 3]);

        let temp_file = NamedTempFile::new().expect("Failed to create temp file");
        let path = temp_file.path();

        // Write
        to_messagepack(&array, path).expect("Failed to write MessagePack");

        // Read
        let loaded: Array<i32> = from_messagepack(path).expect("Failed to read MessagePack");

        assert_eq!(array.shape(), loaded.shape());
        assert_eq!(array.to_vec(), loaded.to_vec());
    }

    #[test]
    fn test_messagepack_roundtrip_f64() {
        let array = Array::from_vec(vec![1.0, 2.0, 3.0, 4.0]).reshape(&[2, 2]);

        let temp_file = NamedTempFile::new().expect("Failed to create temp file");
        let path = temp_file.path();

        // Write
        to_messagepack(&array, path).expect("Failed to write MessagePack");

        // Read
        let loaded: Array<f64> = from_messagepack(path).expect("Failed to read MessagePack");

        assert_eq!(array.shape(), loaded.shape());
        assert_eq!(array.to_vec(), loaded.to_vec());
    }

    #[test]
    fn test_messagepack_bytes() {
        let array = Array::from_vec(vec![1.0, 2.0, 3.0, 4.0]).reshape(&[2, 2]);

        // Serialize to bytes
        let bytes = to_messagepack_bytes(&array).expect("Failed to serialize to bytes");

        // Deserialize from bytes
        let loaded: Array<f64> =
            from_messagepack_bytes(&bytes).expect("Failed to deserialize from bytes");

        assert_eq!(array.shape(), loaded.shape());
        assert_eq!(array.to_vec(), loaded.to_vec());
    }

    #[test]
    fn test_messagepack_1d_array() {
        let array = Array::from_vec(vec![10, 20, 30, 40, 50]);

        let bytes = to_messagepack_bytes(&array).expect("Failed to serialize");
        let loaded: Array<i32> = from_messagepack_bytes(&bytes).expect("Failed to deserialize");

        assert_eq!(array.shape(), loaded.shape());
        assert_eq!(array.to_vec(), loaded.to_vec());
    }

    #[test]
    fn test_messagepack_3d_array() {
        let array = Array::from_vec(vec![1.0; 24]).reshape(&[2, 3, 4]);

        let bytes = to_messagepack_bytes(&array).expect("Failed to serialize");
        let loaded: Array<f64> = from_messagepack_bytes(&bytes).expect("Failed to deserialize");

        assert_eq!(array.shape(), loaded.shape());
        assert_eq!(array.to_vec(), loaded.to_vec());
    }
}