pandrs 0.3.2

A high-performance DataFrame library for Rust, providing pandas-like API with advanced features including SIMD optimization, parallel processing, and distributed computing capabilities
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
use num_traits::NumCast;
use std::cmp::PartialOrd;
use std::fmt::Debug;
use std::iter::Sum;
use std::ops::{Add, Div, Mul, Sub};

use crate::core::error::{Error, Result};
use crate::index::{Index, RangeIndex};
use crate::na::NA;

/// Series structure supporting missing values
#[derive(Debug, Clone)]
pub struct NASeries<T>
where
    T: Debug + Clone,
{
    /// Series data values (wrapped in NA type)
    values: Vec<NA<T>>,

    /// Index labels
    index: RangeIndex,

    /// Name (optional)
    name: Option<String>,
}

impl<T> NASeries<T>
where
    T: Debug + Clone,
{
    /// Create a new NASeries from a vector
    pub fn new(values: Vec<NA<T>>, name: Option<String>) -> Result<Self> {
        let len = values.len();
        let index = RangeIndex::from_range(0..len)?;

        Ok(NASeries {
            values,
            index,
            name,
        })
    }

    /// Helper function to create NASeries from string vector
    pub fn from_strings(
        string_values: Vec<String>,
        name: Option<String>,
    ) -> Result<NASeries<String>> {
        let na_values = string_values
            .into_iter()
            .map(|s| {
                if s.contains("NA") {
                    NA::<String>::NA
                } else {
                    NA::Value(s)
                }
            })
            .collect();
        NASeries::<String>::new(na_values, name)
    }

    /// Create from regular vector (without NA)
    pub fn from_vec(values: Vec<T>, name: Option<String>) -> Result<Self> {
        let na_values = values.into_iter().map(NA::Value).collect();
        Self::new(na_values, name)
    }

    /// Create from vector of Options (may contain None)
    pub fn from_options(values: Vec<Option<T>>, name: Option<String>) -> Result<Self> {
        let na_values = values
            .into_iter()
            .map(|opt| match opt {
                Some(v) => NA::Value(v),
                None => NA::NA,
            })
            .collect();
        Self::new(na_values, name)
    }

    /// Create NASeries with custom index
    pub fn with_index<I>(values: Vec<NA<T>>, index: Index<I>, name: Option<String>) -> Result<Self>
    where
        I: Debug + Clone + Eq + std::hash::Hash + std::fmt::Display,
    {
        if values.len() != index.len() {
            return Err(Error::InconsistentRowCount {
                expected: values.len(),
                found: index.len(),
            });
        }

        // Currently only supporting integer indices
        let range_index = RangeIndex::from_range(0..values.len())?;

        Ok(NASeries {
            values,
            index: range_index,
            name,
        })
    }

    /// Get the length of the NASeries
    pub fn len(&self) -> usize {
        self.values.len()
    }

    /// Check if the NASeries is empty
    pub fn is_empty(&self) -> bool {
        self.values.is_empty()
    }

    /// Get value by position
    pub fn get(&self, pos: usize) -> Option<&NA<T>> {
        self.values.get(pos)
    }

    /// Get the array of values
    pub fn values(&self) -> &[NA<T>] {
        &self.values
    }

    /// Get the name
    pub fn name(&self) -> Option<&String> {
        self.name.as_ref()
    }

    /// Get the index
    pub fn index(&self) -> &RangeIndex {
        &self.index
    }

    /// Set the name
    pub fn with_name(mut self, name: String) -> Self {
        self.name = Some(name);
        self
    }

    /// Set the name (mutable reference)
    pub fn set_name(&mut self, name: String) {
        self.name = Some(name);
    }

    /// Get the count of NA values
    pub fn na_count(&self) -> usize {
        self.values.iter().filter(|v| v.is_na()).count()
    }

    /// Get the count of non-NA values
    pub fn value_count(&self) -> usize {
        self.values.iter().filter(|v| v.is_value()).count()
    }

    /// Check if there are any NA values
    pub fn has_na(&self) -> bool {
        self.values.iter().any(|v| v.is_na())
    }

    /// Get a boolean array indicating which elements are NA
    pub fn is_na(&self) -> Vec<bool> {
        self.values.iter().map(|v| v.is_na()).collect()
    }

    /// Return a Series with NA values removed
    pub fn dropna(&self) -> Result<Self> {
        let filtered_values: Vec<NA<T>> = self
            .values
            .iter()
            .filter(|v| v.is_value())
            .cloned()
            .collect();

        Self::new(filtered_values, self.name.clone())
    }

    /// Fill NA values with a specified value
    pub fn fillna(&self, fill_value: T) -> Result<Self> {
        let filled_values: Vec<NA<T>> = self
            .values
            .iter()
            .map(|v| match v {
                NA::Value(_) => v.clone(),
                NA::NA => NA::Value(fill_value.clone()),
            })
            .collect();

        Self::new(filled_values, self.name.clone())
    }

    /// Shift values by `periods`, filling exposed slots with NA.
    ///
    /// Positive `periods` shifts values toward larger indices (inserts NA at the front);
    /// negative `periods` shifts toward smaller indices (inserts NA at the end).
    /// Existing NA values are preserved at their shifted positions. When
    /// `|periods|` is greater than or equal to the Series length, the result is
    /// all NA. Matches pandas' `Series.shift(periods)` semantics with the default
    /// `fill_value` of NA.
    pub fn shift(&self, periods: i64) -> Result<Self> {
        let len = self.values.len();
        let abs = periods.unsigned_abs().min(len as u64) as usize;
        let mut shifted: Vec<NA<T>> = Vec::with_capacity(len);

        if periods >= 0 {
            for _ in 0..abs {
                shifted.push(NA::NA);
            }
            for v in &self.values[..len - abs] {
                shifted.push(v.clone());
            }
        } else {
            for v in &self.values[abs..] {
                shifted.push(v.clone());
            }
            for _ in 0..abs {
                shifted.push(NA::NA);
            }
        }

        Self::new(shifted, self.name.clone())
    }
}

// Specialized implementation for numeric NASeries
impl<T> NASeries<T>
where
    T: Debug
        + Clone
        + Copy
        + Sum<T>
        + PartialOrd
        + Add<Output = T>
        + Sub<Output = T>
        + Mul<Output = T>
        + Div<Output = T>
        + NumCast
        + Default,
{
    /// Calculate the sum (ignoring NA)
    pub fn sum(&self) -> NA<T> {
        let values: Vec<T> = self
            .values
            .iter()
            .filter_map(|v| match v {
                NA::Value(val) => Some(*val),
                NA::NA => None,
            })
            .collect();

        if values.is_empty() {
            NA::NA
        } else {
            NA::Value(values.into_iter().sum())
        }
    }

    /// Calculate the mean (ignoring NA)
    pub fn mean(&self) -> NA<T> {
        let values: Vec<T> = self
            .values
            .iter()
            .filter_map(|v| match v {
                NA::Value(val) => Some(*val),
                NA::NA => None,
            })
            .collect();

        if values.is_empty() {
            return NA::NA;
        }

        let sum: T = values.iter().copied().sum();
        let count: T = match num_traits::cast(values.len()) {
            Some(n) => n,
            None => return NA::NA,
        };

        NA::Value(sum / count)
    }

    /// Calculate the minimum value (ignoring NA)
    pub fn min(&self) -> NA<T> {
        let values: Vec<T> = self
            .values
            .iter()
            .filter_map(|v| match v {
                NA::Value(val) => Some(*val),
                NA::NA => None,
            })
            .collect();

        if values.is_empty() {
            return NA::NA;
        }

        // SAFETY: We've already checked that values is not empty above
        let min = values
            .iter()
            .min_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal))
            .cloned()
            .expect("min() should succeed on non-empty vector");

        NA::Value(min)
    }

    /// Calculate the maximum value (ignoring NA)
    pub fn max(&self) -> NA<T> {
        let values: Vec<T> = self
            .values
            .iter()
            .filter_map(|v| match v {
                NA::Value(val) => Some(*val),
                NA::NA => None,
            })
            .collect();

        if values.is_empty() {
            return NA::NA;
        }

        // SAFETY: We've already checked that values is not empty above
        let max = values
            .iter()
            .max_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal))
            .cloned()
            .expect("max() should succeed on non-empty vector");

        NA::Value(max)
    }
}

// This NASeries implementation is the current one; no need to re-export the legacy version from here
// The legacy version will be handled in the mod.rs file

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

    #[test]
    fn test_issue_5_shift_positive() -> Result<()> {
        let s = NASeries::<i32>::from_vec(vec![1, 2, 3, 4, 5], Some("x".to_string()))?;
        let shifted = s.shift(1)?;

        assert_eq!(shifted.len(), 5);
        assert_eq!(shifted.name(), Some(&"x".to_string()));
        assert_eq!(shifted.values()[0], NA::NA);
        assert_eq!(shifted.values()[1], NA::Value(1));
        assert_eq!(shifted.values()[2], NA::Value(2));
        assert_eq!(shifted.values()[3], NA::Value(3));
        assert_eq!(shifted.values()[4], NA::Value(4));

        // A larger positive shift still only pads the front and drops from the tail.
        let shifted3 = s.shift(3)?;
        assert_eq!(shifted3.values()[0], NA::NA);
        assert_eq!(shifted3.values()[1], NA::NA);
        assert_eq!(shifted3.values()[2], NA::NA);
        assert_eq!(shifted3.values()[3], NA::Value(1));
        assert_eq!(shifted3.values()[4], NA::Value(2));

        // Existing NAs are preserved at their shifted positions.
        let mixed = NASeries::<i32>::new(
            vec![NA::Value(10), NA::NA, NA::Value(30), NA::Value(40)],
            Some("mixed".to_string()),
        )?;
        let mixed_shifted = mixed.shift(1)?;
        assert_eq!(mixed_shifted.values()[0], NA::NA);
        assert_eq!(mixed_shifted.values()[1], NA::Value(10));
        assert_eq!(mixed_shifted.values()[2], NA::NA);
        assert_eq!(mixed_shifted.values()[3], NA::Value(30));

        Ok(())
    }

    #[test]
    fn test_issue_5_shift_negative() -> Result<()> {
        let s = NASeries::<i32>::from_vec(vec![1, 2, 3, 4, 5], Some("x".to_string()))?;
        let shifted = s.shift(-2)?;

        assert_eq!(shifted.len(), 5);
        assert_eq!(shifted.name(), Some(&"x".to_string()));
        assert_eq!(shifted.values()[0], NA::Value(3));
        assert_eq!(shifted.values()[1], NA::Value(4));
        assert_eq!(shifted.values()[2], NA::Value(5));
        assert_eq!(shifted.values()[3], NA::NA);
        assert_eq!(shifted.values()[4], NA::NA);

        // Negative one-step shift pads just the tail.
        let shifted1 = s.shift(-1)?;
        assert_eq!(shifted1.values()[0], NA::Value(2));
        assert_eq!(shifted1.values()[3], NA::Value(5));
        assert_eq!(shifted1.values()[4], NA::NA);

        // Existing NAs are preserved at their shifted positions.
        let mixed = NASeries::<i32>::new(
            vec![NA::Value(10), NA::NA, NA::Value(30), NA::Value(40)],
            None,
        )?;
        let mixed_shifted = mixed.shift(-1)?;
        assert_eq!(mixed_shifted.values()[0], NA::NA);
        assert_eq!(mixed_shifted.values()[1], NA::Value(30));
        assert_eq!(mixed_shifted.values()[2], NA::Value(40));
        assert_eq!(mixed_shifted.values()[3], NA::NA);

        Ok(())
    }

    #[test]
    fn test_issue_5_shift_zero() -> Result<()> {
        let s = NASeries::<i32>::new(
            vec![
                NA::Value(1),
                NA::NA,
                NA::Value(3),
                NA::Value(4),
                NA::Value(5),
            ],
            Some("x".to_string()),
        )?;
        let shifted = s.shift(0)?;

        assert_eq!(shifted.len(), 5);
        assert_eq!(shifted.name(), Some(&"x".to_string()));
        assert_eq!(shifted.values()[0], NA::Value(1));
        assert_eq!(shifted.values()[1], NA::NA);
        assert_eq!(shifted.values()[2], NA::Value(3));
        assert_eq!(shifted.values()[3], NA::Value(4));
        assert_eq!(shifted.values()[4], NA::Value(5));

        Ok(())
    }

    #[test]
    fn test_issue_5_shift_exceeds_len() -> Result<()> {
        let s = NASeries::<i32>::from_vec(vec![1, 2, 3, 4, 5], Some("x".to_string()))?;

        // |periods| == len: the entire result is NA.
        let exactly = s.shift(5)?;
        assert_eq!(exactly.len(), 5);
        assert!(exactly.values().iter().all(|v| v.is_na()));

        // |periods| > len in the positive direction.
        let overshoot_pos = s.shift(10)?;
        assert_eq!(overshoot_pos.len(), 5);
        assert!(overshoot_pos.values().iter().all(|v| v.is_na()));

        // |periods| > len in the negative direction.
        let overshoot_neg = s.shift(-10)?;
        assert_eq!(overshoot_neg.len(), 5);
        assert!(overshoot_neg.values().iter().all(|v| v.is_na()));

        // Empty series with any periods stays empty.
        let empty = NASeries::<i32>::from_vec(vec![], None)?;
        let shifted_empty = empty.shift(3)?;
        assert_eq!(shifted_empty.len(), 0);
        let shifted_empty_neg = empty.shift(-3)?;
        assert_eq!(shifted_empty_neg.len(), 0);

        Ok(())
    }
}