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

use vortex_array::aliases::hash_set::HashSet;
use vortex_array::array::{
    PrimitiveArray, PrimitiveEncoding, VarBinArray, VarBinEncoding, VarBinViewArray,
    VarBinViewEncoding,
};
use vortex_array::encoding::{Encoding, EncodingRef};
use vortex_array::stats::ArrayStatistics;
use vortex_array::{ArrayData, IntoArrayData};
use vortex_dict::{
    dict_encode_primitive, dict_encode_varbin, dict_encode_varbinview, DictArray, DictEncoding,
};
use vortex_error::VortexResult;

use crate::compressors::{CompressedArray, CompressionTree, EncodingCompressor};
use crate::downscale::downscale_integer_array;
use crate::{constants, SamplingCompressor};

#[derive(Debug)]
pub struct DictCompressor;

impl EncodingCompressor for DictCompressor {
    fn id(&self) -> &str {
        DictEncoding::ID.as_ref()
    }

    fn cost(&self) -> u8 {
        constants::DICT_COST
    }

    fn can_compress(&self, array: &ArrayData) -> Option<&dyn EncodingCompressor> {
        if !array.is_encoding(PrimitiveEncoding::ID)
            && !array.is_encoding(VarBinEncoding::ID)
            && !array.is_encoding(VarBinViewEncoding::ID)
        {
            return None;
        };

        // No point dictionary coding if the array is unique.
        // We don't have a unique stat yet, but strict-sorted implies unique.
        if array
            .statistics()
            .compute_is_strict_sorted()
            .unwrap_or(false)
        {
            return None;
        }

        Some(self)
    }

    fn compress<'a>(
        &'a self,
        array: &ArrayData,
        like: Option<CompressionTree<'a>>,
        ctx: SamplingCompressor<'a>,
    ) -> VortexResult<CompressedArray<'a>> {
        let (codes, values) = if let Some(p) = PrimitiveArray::maybe_from(array) {
            let (codes, values) = dict_encode_primitive(&p);
            (codes.into_array(), values.into_array())
        } else if let Some(vb) = VarBinArray::maybe_from(array) {
            let (codes, values) = dict_encode_varbin(&vb);
            (codes.into_array(), values.into_array())
        } else if let Some(vb) = VarBinViewArray::maybe_from(array) {
            let (codes, values) = dict_encode_varbinview(&vb);
            (codes.into_array(), values.into_array())
        } else {
            unreachable!("This array kind should have been filtered out");
        };

        let (codes, values) = (
            ctx.auxiliary("codes").excluding(self).compress(
                &downscale_integer_array(codes)?,
                like.as_ref().and_then(|l| l.child(0)),
            )?,
            ctx.named("values")
                .excluding(self)
                .compress(&values, like.as_ref().and_then(|l| l.child(1)))?,
        );

        Ok(CompressedArray::compressed(
            DictArray::try_new(codes.array, values.array)?.into_array(),
            Some(CompressionTree::new(self, vec![codes.path, values.path])),
            array,
        ))
    }

    fn used_encodings(&self) -> HashSet<EncodingRef> {
        HashSet::from([&DictEncoding as EncodingRef])
    }
}