dataprof 0.7.1

High-performance data profiler with ISO 8000/25012 quality metrics for CSV, JSON/JSONL, and Parquet files
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
use crate::acceleration::simd::compute_stats_auto;
use crate::types::{ColumnStats, NumericStats, Quartiles};
use std::collections::HashMap;

const SAMPLE_THRESHOLD: usize = 10_000;

pub fn calculate_numeric_stats(data: &[String]) -> ColumnStats {
    ColumnStats::Numeric(compute_numeric_stats(data))
}

/// Compute numeric stats and return the inner struct directly.
pub fn compute_numeric_stats(data: &[String]) -> NumericStats {
    let numbers: Vec<f64> = data
        .iter()
        .filter_map(|s| s.parse::<f64>().ok())
        .filter(|x| x.is_finite())
        .collect();

    if numbers.is_empty() {
        return NumericStats::empty();
    }

    // Single SIMD-accelerated pass for base statistics (min, max, sum, sum_squares)
    // Automatically falls back to scalar for small datasets (<64 elements)
    let base = compute_stats_auto(&numbers);
    let min = base.min;
    let max = base.max;
    let mean = base.mean();
    let mut variance = calculate_variance(base.sum_squares, base.sum, numbers.len());

    // Fallback if variance is invalid or sum_squares overflowed
    // Tiny negative variances can happen due to floating point catastrophic cancellation
    if (!variance.is_finite() || variance < 0.0 || base.sum_squares.is_infinite())
        && numbers.len() > 1
    {
        let mut welford_mean = 0.0;
        let mut welford_m2 = 0.0;
        for (i, &x) in numbers.iter().enumerate() {
            let n = (i + 1) as f64;
            let delta = x - welford_mean;
            welford_mean += delta / n;
            let delta2 = x - welford_mean;
            welford_m2 += delta * delta2;
        }
        variance = welford_m2 / (numbers.len() - 1) as f64;
    }

    // Ensure variance doesn't become slightly negative before taking sqrt
    let safe_variance = variance.max(0.0);
    let std_dev = safe_variance.sqrt();

    // Determine if we need sampling for large datasets
    let (sample_data, is_approximate) = if numbers.len() > SAMPLE_THRESHOLD {
        (reservoir_sample(&numbers, SAMPLE_THRESHOLD), Some(true))
    } else {
        (numbers.clone(), None)
    };

    // Statistics requiring sorted/complete data
    let mut sorted_data = sample_data.clone();
    sorted_data.sort_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal));

    let median = calculate_median(&sorted_data);
    let quartiles = calculate_quartiles(&sorted_data);
    let mode = calculate_mode(&sample_data);
    let coefficient_of_variation = calculate_coefficient_of_variation(std_dev, mean);

    // Advanced metrics
    let skewness = calculate_skewness(&sample_data, mean, std_dev);
    let kurtosis = calculate_kurtosis(&sample_data, mean, std_dev);

    NumericStats {
        min,
        max,
        mean,
        std_dev,
        variance,
        median,
        quartiles,
        mode,
        coefficient_of_variation,
        skewness,
        kurtosis,
        is_approximate,
    }
}

/// Calculate variance using sum of squares
/// Uses sample variance (n-1) for unbiased estimation
pub fn calculate_variance(sum_squares: f64, sum: f64, count: usize) -> f64 {
    let n = count as f64;
    if n <= 1.0 {
        return 0.0;
    }

    let mean = sum / n;
    (sum_squares - n * mean * mean) / (n - 1.0)
}

/// Calculate median from sorted data
pub fn calculate_median(sorted_data: &[f64]) -> Option<f64> {
    if sorted_data.is_empty() {
        return None;
    }

    let len = sorted_data.len();
    #[allow(clippy::manual_is_multiple_of)]
    if len % 2 == 0 {
        // Even number of elements - average of two middle values
        let mid1 = sorted_data[len / 2 - 1];
        let mid2 = sorted_data[len / 2];
        Some((mid1 + mid2) / 2.0)
    } else {
        // Odd number of elements - middle value
        Some(sorted_data[len / 2])
    }
}

/// Calculate quartiles using Type 7 interpolation (R/Excel default)
pub fn calculate_quartiles(sorted_data: &[f64]) -> Option<Quartiles> {
    if sorted_data.len() < 4 {
        return None;
    }

    let n = sorted_data.len() as f64;

    let q1 = calculate_percentile(sorted_data, 0.25, n);
    let q2 = calculate_percentile(sorted_data, 0.50, n);
    let q3 = calculate_percentile(sorted_data, 0.75, n);

    let iqr = q3 - q1;

    Some(Quartiles { q1, q2, q3, iqr })
}

/// Calculate percentile using Type 7 linear interpolation (R/Excel/pandas default)
fn calculate_percentile(sorted_data: &[f64], p: f64, n: f64) -> f64 {
    // Type 7 (0-indexed): pos = p * (n - 1)
    let pos = p * (n - 1.0);

    if pos < 0.0 {
        return sorted_data[0];
    }
    if pos >= n - 1.0 {
        return sorted_data[(n as usize) - 1];
    }

    let lower_idx = pos.floor() as usize;
    let upper_idx = pos.ceil() as usize;

    if lower_idx == upper_idx {
        sorted_data[lower_idx]
    } else {
        let weight = pos - lower_idx as f64;
        sorted_data[lower_idx] * (1.0 - weight) + sorted_data[upper_idx] * weight
    }
}

/// Calculate mode (most frequent value)
/// For multimodal distributions, returns the smallest value with maximum frequency
pub fn calculate_mode(data: &[f64]) -> Option<f64> {
    if data.is_empty() {
        return None;
    }

    let mut freq_map: HashMap<String, usize> = HashMap::new();

    // Use string representation to handle floating point comparison
    for &value in data {
        let key = format!("{:.10}", value); // 10 decimal precision
        *freq_map.entry(key).or_insert(0) += 1;
    }

    // Find maximum frequency
    let max_freq = *freq_map.values().max()?;

    // If all values are unique, return None
    if max_freq == 1 {
        return None;
    }

    // Find all values with maximum frequency and return the smallest (deterministic)
    let mut modes: Vec<f64> = freq_map
        .iter()
        .filter(|(_, count)| **count == max_freq)
        .filter_map(|(value, _)| value.parse::<f64>().ok())
        .collect();
    modes.sort_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal));
    modes.first().copied()
}

/// Calculate coefficient of variation (CV)
pub fn calculate_coefficient_of_variation(std_dev: f64, mean: f64) -> Option<f64> {
    if mean.abs() < 0.001 {
        // Avoid division by zero
        None
    } else {
        Some((std_dev / mean.abs()) * 100.0)
    }
}

/// Calculate skewness (Pearson's moment coefficient)
pub fn calculate_skewness(data: &[f64], mean: f64, std_dev: f64) -> Option<f64> {
    if data.len() < 3 || std_dev < 1e-10 {
        return None;
    }

    let n = data.len() as f64;
    let sum_cubed: f64 = data
        .iter()
        .map(|&x| {
            let z = (x - mean) / std_dev;
            z * z * z
        })
        .sum();

    Some(sum_cubed / n)
}

/// Calculate kurtosis (excess kurtosis)
pub fn calculate_kurtosis(data: &[f64], mean: f64, std_dev: f64) -> Option<f64> {
    if data.len() < 4 || std_dev < 1e-10 {
        return None;
    }

    let n = data.len() as f64;
    let sum_fourth: f64 = data
        .iter()
        .map(|&x| {
            let z = (x - mean) / std_dev;
            let z2 = z * z;
            z2 * z2
        })
        .sum();

    // Excess kurtosis (subtract 3 for normal distribution)
    Some((sum_fourth / n) - 3.0)
}

/// Reservoir sampling for large datasets
fn reservoir_sample(data: &[f64], k: usize) -> Vec<f64> {
    use rand::Rng;

    if data.len() <= k {
        return data.to_vec();
    }

    let mut rng = rand::rng();
    let mut reservoir: Vec<f64> = data[0..k].to_vec();

    for (i, &value) in data.iter().enumerate().skip(k) {
        let j = rng.random_range(0..=i);
        if j < k {
            reservoir[j] = value;
        }
    }

    reservoir
}

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

    #[test]
    fn test_median_odd_count() {
        let sorted = vec![1.0, 2.0, 3.0];
        assert_eq!(calculate_median(&sorted), Some(2.0));
    }

    #[test]
    fn test_median_even_count() {
        let sorted = vec![1.0, 2.0, 3.0, 4.0];
        assert_eq!(calculate_median(&sorted), Some(2.5));
    }

    #[test]
    fn test_median_empty() {
        let sorted: Vec<f64> = vec![];
        assert_eq!(calculate_median(&sorted), None);
    }

    #[test]
    fn test_quartiles() {
        let sorted = vec![1.0, 2.0, 3.0, 4.0, 5.0];
        let q = calculate_quartiles(&sorted).unwrap();
        assert!((q.q1 - 2.0).abs() < 0.01);
        assert_eq!(q.q2, 3.0);
        assert!((q.q3 - 4.0).abs() < 0.01);
        assert!((q.iqr - 2.0).abs() < 0.01);
    }

    #[test]
    fn test_quartiles_small_dataset() {
        let sorted = vec![1.0, 2.0];
        assert_eq!(calculate_quartiles(&sorted), None);
    }

    #[test]
    fn test_mode_unique_values() {
        let data = vec![1.0, 2.0, 3.0];
        assert_eq!(calculate_mode(&data), None);
    }

    #[test]
    fn test_mode_with_duplicates() {
        let data = vec![1.0, 2.0, 2.0, 3.0];
        assert_eq!(calculate_mode(&data), Some(2.0));
    }

    #[test]
    fn test_mode_empty() {
        let data: Vec<f64> = vec![];
        assert_eq!(calculate_mode(&data), None);
    }

    #[test]
    fn test_skewness_symmetric() {
        let data = vec![1.0, 2.0, 3.0, 4.0, 5.0];
        let mean = 3.0;
        let std_dev = (2.0_f64).sqrt();
        let skew = calculate_skewness(&data, mean, std_dev).unwrap();
        assert!(skew.abs() < 0.1); // Symmetric distribution
    }

    #[test]
    fn test_coefficient_of_variation() {
        let cv = calculate_coefficient_of_variation(10.0, 100.0);
        assert_eq!(cv, Some(10.0));
    }

    #[test]
    fn test_cv_zero_mean() {
        let cv = calculate_coefficient_of_variation(1.0, 0.0);
        assert_eq!(cv, None);
    }

    #[test]
    fn test_kurtosis() {
        let data = vec![1.0, 2.0, 3.0, 4.0, 5.0];
        let mean = 3.0;
        let std_dev = (2.0_f64).sqrt();
        let kurt = calculate_kurtosis(&data, mean, std_dev);
        assert!(kurt.is_some());
    }

    #[test]
    fn test_variance() {
        let sum_squares = 55.0; // 1² + 2² + 3² + 4² + 5²
        let sum = 15.0; // 1 + 2 + 3 + 4 + 5
        let count = 5;
        let var = calculate_variance(sum_squares, sum, count);
        // Sample variance (n-1): 2.5
        assert!((var - 2.5).abs() < 0.01);
    }

    #[test]
    fn test_calculate_numeric_stats_basic() {
        let data = vec!["10".to_string(), "20".to_string(), "30".to_string()];
        let stats = calculate_numeric_stats(&data);

        match stats {
            ColumnStats::Numeric(n) => {
                assert_eq!(n.min, 10.0);
                assert_eq!(n.max, 30.0);
                assert_eq!(n.mean, 20.0);
                assert!(n.std_dev > 0.0);
                assert_eq!(n.median, Some(20.0));
            }
            _ => panic!("Expected Numeric stats"),
        }
    }

    #[test]
    fn test_calculate_numeric_stats_empty() {
        let data: Vec<String> = vec![];
        let stats = calculate_numeric_stats(&data);

        match stats {
            ColumnStats::Numeric(n) => {
                assert_eq!(n.min, 0.0);
                assert_eq!(n.max, 0.0);
                assert_eq!(n.mean, 0.0);
                assert_eq!(n.median, None);
            }
            _ => panic!("Expected Numeric stats"),
        }
    }

    #[test]
    fn test_numeric_stats_filters_nan() {
        let data = vec!["1.0".to_string(), "NaN".to_string(), "3.0".to_string()];
        let stats = calculate_numeric_stats(&data);

        match stats {
            ColumnStats::Numeric(n) => {
                assert_eq!(n.min, 1.0);
                assert_eq!(n.max, 3.0);
                assert_eq!(n.mean, 2.0);
            }
            _ => panic!("Expected Numeric stats"),
        }
    }

    #[test]
    fn test_numeric_stats_filters_infinity() {
        let data = vec![
            "1.0".to_string(),
            "inf".to_string(),
            "3.0".to_string(),
            "-inf".to_string(),
        ];
        let stats = calculate_numeric_stats(&data);

        match stats {
            ColumnStats::Numeric(n) => {
                assert_eq!(n.min, 1.0);
                assert_eq!(n.max, 3.0);
                assert_eq!(n.mean, 2.0);
            }
            _ => panic!("Expected Numeric stats"),
        }
    }

    #[test]
    fn test_numeric_stats_all_nan() {
        let data = vec!["NaN".to_string(), "inf".to_string(), "-inf".to_string()];
        let stats = calculate_numeric_stats(&data);

        match stats {
            ColumnStats::Numeric(n) => {
                assert_eq!(n.min, 0.0);
                assert_eq!(n.max, 0.0);
                assert_eq!(n.mean, 0.0);
                assert_eq!(n.median, None);
            }
            _ => panic!("Expected Numeric stats"),
        }
    }
}