risingwave_common/util/
compress.rs

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
// Copyright 2024 RisingWave Labs
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use super::iter_util::ZipEqFast;

/// This function compresses sequential repeated data in a vector. The compression result contains
/// two vectors, one for the last indices of sequential repeated elements, and another for the
/// repeated data. For example, [14, 14, 14, 27, 27] will be compressed to [2, 4], [14, 27].
pub fn compress_data<T>(original_data: &[T]) -> (Vec<u32>, Vec<T>)
where
    T: PartialEq + Copy,
{
    let mut original_indices = Vec::new();
    let mut data = Vec::new();

    for i in 1..original_data.len() {
        if original_data[i - 1] != original_data[i] {
            original_indices.push(i as u32 - 1);
            data.push(original_data[i - 1]);
        }
    }

    if let Some(&last) = original_data.last() {
        original_indices.push(original_data.len() as u32 - 1);
        data.push(last);
    }

    (original_indices, data)
}

/// Works in a reversed way as `compress_data`.
pub fn decompress_data<T>(original_indices: &[u32], data: &[T]) -> Vec<T>
where
    T: Copy,
{
    match original_indices.last() {
        Some(last_idx) => {
            let mut original_data = Vec::with_capacity(*last_idx as usize + 1);
            original_indices
                .iter()
                .zip_eq_fast(data)
                .for_each(|(&idx, &x)| {
                    original_data.resize(idx as usize + 1, x);
                });
            original_data
        }
        None => Vec::new(),
    }
}

#[cfg(test)]
mod tests {
    use super::{compress_data, decompress_data};

    #[test]
    fn test_compress() {
        // Simple
        let original_data = [3u32, 3, 3, 3, 3, 4, 4, 5, 5, 6, 7, 8, 8, 8, 9];
        let (compressed_original_indices, compressed_data) = compress_data(&original_data);
        let expect_original_indices = Vec::from([4u32, 6, 8, 9, 10, 13, 14]);
        let expect_data = Vec::from([3u32, 4, 5, 6, 7, 8, 9]);
        assert_eq!(compressed_original_indices, expect_original_indices);
        assert_eq!(compressed_data, expect_data);
        let decompressed_data = decompress_data(&compressed_original_indices, &compressed_data);
        assert_eq!(decompressed_data, original_data);

        // Complex
        let mut long_original_data = Vec::new();
        long_original_data.resize(512, 1);
        long_original_data.resize(1024, 2);
        long_original_data.resize(1536, 3);
        long_original_data.resize(2048, 4);
        long_original_data[0] = 5;
        long_original_data[2046] = 5;
        let (compressed_original_indices, compressed_data) = compress_data(&long_original_data);
        let expect_original_indices = Vec::from([0u32, 511, 1023, 1535, 2045, 2046, 2047]);
        let expect_data = Vec::from([5u32, 1, 2, 3, 4, 5, 4]);
        assert_eq!(compressed_original_indices, expect_original_indices);
        assert_eq!(compressed_data, expect_data);
        let decompressed_data = decompress_data(&compressed_original_indices, &compressed_data);
        assert_eq!(decompressed_data, long_original_data);

        // Empty
        let (compressed_original_indices, compressed_data) = compress_data::<u8>(&[]);
        assert!(compressed_original_indices.is_empty());
        assert!(compressed_data.is_empty());
        let decompressed_data = decompress_data(&compressed_original_indices, &compressed_data);
        assert!(decompressed_data.is_empty());
    }
}