cydec 0.0.4

High-performance compression library for numerical time series data using delta encoding, zigzag encoding, and LZ4
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
458
459
460
use anyhow::Result;
use cydec::{FloatingCodec, IntegerCodec};

// Test determinism: same input produces same output

#[test]
fn test_i64_determinism() -> Result<()> {
    let codec = IntegerCodec::default();
    let data: Vec<i64> = (0..1000).collect();

    let compressed1 = codec.compress_i64(&data)?;
    let compressed2 = codec.compress_i64(&data)?;
    let compressed3 = codec.compress_i64(&data)?;

    assert_eq!(
        compressed1, compressed2,
        "Compression should be deterministic"
    );
    assert_eq!(
        compressed2, compressed3,
        "Compression should be deterministic"
    );
    Ok(())
}

#[test]
fn test_f64_determinism() -> Result<()> {
    let codec = FloatingCodec::default();
    let data: Vec<f64> = (0..1000).map(|i| i as f64 * 0.1).collect();

    let compressed1 = codec.compress_f64(&data, None)?;
    let compressed2 = codec.compress_f64(&data, None)?;
    let compressed3 = codec.compress_f64(&data, None)?;

    assert_eq!(
        compressed1, compressed2,
        "Compression should be deterministic"
    );
    assert_eq!(
        compressed2, compressed3,
        "Compression should be deterministic"
    );
    Ok(())
}

// Test data integrity: no corruption

#[test]
fn test_i64_data_integrity_extremes() -> Result<()> {
    let codec = IntegerCodec::default();
    let data = vec![
        i64::MIN,
        i64::MIN + 1,
        -1000000,
        -1,
        0,
        1,
        1000000,
        i64::MAX - 1,
        i64::MAX,
    ];

    let compressed = codec.compress_i64(&data)?;
    let decompressed = codec.decompress_i64(&compressed)?;

    assert_eq!(
        data, decompressed,
        "Extreme values must be preserved exactly"
    );
    Ok(())
}

#[test]
fn test_u64_data_integrity_extremes() -> Result<()> {
    let codec = IntegerCodec::default();
    let data = vec![0, 1, 1000000, u64::MAX / 2, u64::MAX - 1, u64::MAX];

    let compressed = codec.compress_u64(&data)?;
    let decompressed = codec.decompress_u64(&compressed)?;

    assert_eq!(
        data, decompressed,
        "Extreme values must be preserved exactly"
    );
    Ok(())
}

// Test compression ratio expectations

#[test]
fn test_sequential_compression_ratio() -> Result<()> {
    let codec = IntegerCodec::default();
    let data: Vec<i64> = (0..10_000).collect();

    let compressed = codec.compress_i64(&data)?;

    let original_size = data.len() * 8;
    let compressed_size = compressed.len();
    let ratio = original_size as f64 / compressed_size as f64;

    assert!(
        ratio > 10.0,
        "Sequential data should compress > 10x, got {:.2}x",
        ratio
    );
    Ok(())
}

#[test]
fn test_constant_compression_ratio() -> Result<()> {
    let codec = IntegerCodec::default();
    let data = vec![42i64; 10_000];

    let compressed = codec.compress_i64(&data)?;

    let original_size = data.len() * 8;
    let compressed_size = compressed.len();
    let ratio = original_size as f64 / compressed_size as f64;

    assert!(
        ratio > 50.0,
        "Constant data should compress > 50x, got {:.2}x",
        ratio
    );
    Ok(())
}

#[test]
fn test_time_series_compression_ratio() -> Result<()> {
    let codec = IntegerCodec::default();

    // Simulate time-series: slowly changing values
    let mut data = Vec::new();
    let mut val = 1000i64;
    for _ in 0..10_000 {
        data.push(val);
        val += 1; // Small delta
    }

    let compressed = codec.compress_i64(&data)?;

    let original_size = data.len() * 8;
    let compressed_size = compressed.len();
    let ratio = original_size as f64 / compressed_size as f64;

    assert!(
        ratio > 10.0,
        "Time-series data should compress > 10x, got {:.2}x",
        ratio
    );
    Ok(())
}

// Test floating-point precision

#[test]
fn test_f64_precision_default_scale() -> Result<()> {
    let codec = FloatingCodec::default();
    let data = vec![
        1.123456789,
        2.234567890,
        3.345678901,
        4.456789012,
        5.567890123,
    ];

    let compressed = codec.compress_f64(&data, None)?;
    let decompressed = codec.decompress_f64(&compressed, None)?;

    for (original, decoded) in data.iter().zip(decompressed.iter()) {
        let error = (original - decoded).abs();
        assert!(
            error < 1e-9,
            "f64 precision error too large: {} vs {}, error: {}",
            original,
            decoded,
            error
        );
    }
    Ok(())
}

#[test]
fn test_f32_precision_default_scale() -> Result<()> {
    let codec = FloatingCodec::default();
    let data = vec![1.123456, 2.234567, 3.345678, 4.456789, 5.567_89];

    let compressed = codec.compress_f32(&data, None)?;
    let decompressed = codec.decompress_f32(&compressed, None)?;

    for (original, decoded) in data.iter().zip(decompressed.iter()) {
        let error = (original - decoded).abs();
        assert!(
            error < 1e-6,
            "f32 precision error too large: {} vs {}, error: {}",
            original,
            decoded,
            error
        );
    }
    Ok(())
}

// Test known good outputs (regression tests)

#[test]
fn test_i64_known_output_format() -> Result<()> {
    let codec = IntegerCodec::default();
    let data = vec![100i64, 101, 102, 103, 104];

    let compressed = codec.compress_i64(&data)?;

    // Verify header
    assert_eq!(&compressed[0..5], b"CYDEC", "Magic bytes should be CYDEC");
    assert_eq!(compressed[5], 1, "Version should be 1");
    assert_eq!(compressed[6], 1, "Codec should be 1 (LZ4)");
    assert_eq!(compressed[7], 0, "Type should be 0 (i64)");

    // Verify length field
    let len = u64::from_le_bytes(compressed[8..16].try_into().unwrap());
    assert_eq!(len, 5, "Length should be 5");

    Ok(())
}

#[test]
fn test_f64_known_output_format() -> Result<()> {
    let codec = FloatingCodec::default();
    let data = vec![1.0, 2.0, 3.0, 4.0, 5.0];

    let compressed = codec.compress_f64(&data, None)?;

    // Verify header
    assert_eq!(&compressed[0..5], b"CYDEC", "Magic bytes should be CYDEC");
    assert_eq!(compressed[5], 1, "Version should be 1");
    assert_eq!(compressed[6], 1, "Codec should be 1 (LZ4)");
    assert_eq!(compressed[7], 4, "Type should be 4 (f64)");

    // Verify length field
    let len = u64::from_le_bytes(compressed[8..16].try_into().unwrap());
    assert_eq!(len, 5, "Length should be 5");

    // Verify scale factor field
    let scale = f64::from_le_bytes(compressed[16..24].try_into().unwrap());
    assert_eq!(
        scale,
        FloatingCodec::DEFAULT_F64_SCALE,
        "Scale should be default"
    );

    Ok(())
}

// Test zigzag encoding correctness

#[test]
fn test_zigzag_encoding_coverage() -> Result<()> {
    let codec = IntegerCodec::default();

    // Test various patterns that stress zigzag encoding
    let test_cases = vec![
        vec![0, 1, -1, 2, -2, 3, -3],     // Alternating signs
        vec![-10, -9, -8, -7, -6],        // Negative sequence
        vec![10, 9, 8, 7, 6],             // Descending
        vec![-100, 0, 100, -100, 0, 100], // Oscillating
        vec![i64::MIN, 0, i64::MAX],      // Extreme jumps
    ];

    for data in test_cases {
        let compressed = codec.compress_i64(&data)?;
        let decompressed = codec.decompress_i64(&compressed)?;
        assert_eq!(
            data, decompressed,
            "Zigzag encoding failed for pattern: {:?}",
            data
        );
    }

    Ok(())
}

// Test parallel consistency

#[test]
fn test_parallel_sequential_consistency() -> Result<()> {
    let codec = IntegerCodec::default();

    let arrays: Vec<Vec<i64>> = (0..100)
        .map(|k| (0..1000).map(|i| i * k).collect())
        .collect();

    // Sequential compression
    let sequential: Vec<Vec<u8>> = arrays
        .iter()
        .map(|a| codec.compress_i64(a).unwrap())
        .collect();

    // Parallel compression
    let parallel = codec.compress_many_i64(&arrays)?;

    assert_eq!(
        sequential, parallel,
        "Parallel and sequential compression should produce identical results"
    );

    Ok(())
}

// Test scale factor preservation

#[test]
fn test_scale_factor_embedded_in_blob() -> Result<()> {
    let codec = FloatingCodec::default();
    let data = vec![1.1, 2.2, 3.3];
    let custom_scale = 12345.6789;

    let compressed = codec.compress_f64(&data, Some(custom_scale))?;

    // Decompress without providing scale (should use embedded scale)
    let decompressed = codec.decompress_f64(&compressed, None)?;

    for (original, decoded) in data.iter().zip(decompressed.iter()) {
        let error = (original - decoded).abs();
        let tolerance = 1.0 / custom_scale + 1e-15;
        assert!(
            error < tolerance,
            "Scale factor not properly embedded/extracted: {} vs {}, error: {}",
            original,
            decoded,
            error
        );
    }

    Ok(())
}

// Test compression doesn't lose data

#[test]
fn test_no_data_loss_large_dataset() -> Result<()> {
    let codec = IntegerCodec::default();
    let data: Vec<i64> = (0..100_000).map(|i| i * 7 + 13).collect();

    let compressed = codec.compress_i64(&data)?;
    let decompressed = codec.decompress_i64(&compressed)?;

    // Verify every single element
    assert_eq!(data.len(), decompressed.len(), "Length mismatch");
    for (i, (original, decoded)) in data.iter().zip(decompressed.iter()).enumerate() {
        assert_eq!(
            original, decoded,
            "Data loss at index {}: {} vs {}",
            i, original, decoded
        );
    }

    Ok(())
}

// Test compression of special float values

#[test]
fn test_f64_special_values() -> Result<()> {
    let codec = FloatingCodec::default();

    // Test zeros, very small, very large
    // Note: Use smaller scale (1e6) for very large values to avoid i64 overflow
    // since 1e10 * 1e9 (default scale) > i64::MAX
    let data = vec![
        0.0,
        -0.0,
        1e-10,
        -1e-10,
        1e10,
        -1e10,
        std::f64::consts::PI,
        std::f64::consts::E,
    ];

    // Use custom scale to avoid overflow on large values
    let custom_scale = 1e6;
    let compressed = codec.compress_f64(&data, Some(custom_scale))?;
    let decompressed = codec.decompress_f64(&compressed, None)?;

    for (i, (original, decoded)) in data.iter().zip(decompressed.iter()).enumerate() {
        let error = (original - decoded).abs();
        let tolerance = original.abs() * (1.0 / custom_scale) + (1.0 / custom_scale);
        assert!(
            error < tolerance,
            "Special value mismatch at index {}: {} vs {}, error: {}",
            i,
            original,
            decoded,
            error
        );
    }

    Ok(())
}

// Test byte compression preserves all byte values

#[test]
fn test_bytes_all_values() -> Result<()> {
    let codec = IntegerCodec::default();

    // Test all possible byte values
    let data: Vec<u8> = (0..=255).collect();

    let compressed = codec.compress_bytes(&data)?;
    let decompressed = codec.decompress_bytes(&compressed)?;

    assert_eq!(data, decompressed, "All byte values should be preserved");

    Ok(())
}

// Test large deltas

#[test]
fn test_i64_large_deltas() -> Result<()> {
    let codec = IntegerCodec::default();

    // Create data with very large deltas
    let data = vec![0, i64::MAX / 2, i64::MIN / 2, 0, i64::MAX, i64::MIN, 0];

    let compressed = codec.compress_i64(&data)?;
    let decompressed = codec.decompress_i64(&compressed)?;

    assert_eq!(
        data, decompressed,
        "Large deltas should be handled correctly"
    );

    Ok(())
}

// Test wrapping arithmetic correctness

#[test]
fn test_wrapping_arithmetic() -> Result<()> {
    let codec = IntegerCodec::default();

    // Test that wrapping is handled correctly
    let data = vec![
        i64::MAX - 5,
        i64::MAX - 4,
        i64::MAX - 3,
        i64::MAX - 2,
        i64::MAX - 1,
        i64::MAX,
    ];

    let compressed = codec.compress_i64(&data)?;
    let decompressed = codec.decompress_i64(&compressed)?;

    assert_eq!(data, decompressed, "Near-max values should wrap correctly");

    Ok(())
}