vortex-compressor 0.69.0

Encoding-agnostic compression framework for Vortex arrays
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

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

//! Built-in compression schemes that use only `vortex-array` encodings.
//!
//! These schemes produce arrays using types already in `vortex-array` ([`ConstantArray`],
//! [`DictArray`], [`MaskedArray`], etc.) and have no external encoding crate dependencies.
//!
//! [`ConstantArray`]: vortex_array::arrays::ConstantArray
//! [`DictArray`]: vortex_array::arrays::DictArray
//! [`MaskedArray`]: vortex_array::arrays::MaskedArray

use vortex_array::Canonical;
use vortex_array::dtype::DType;
use vortex_array::dtype::Nullability;

/// Returns `true` if the canonical array is a primitive with an integer ptype.
pub fn is_integer_primitive(canonical: &Canonical) -> bool {
    matches!(canonical, Canonical::Primitive(p) if p.ptype().is_int())
}

/// Returns `true` if the canonical form represents a floating-point primitive.
pub fn is_float_primitive(canonical: &Canonical) -> bool {
    matches!(canonical, Canonical::Primitive(p) if !p.ptype().is_int())
}

/// Returns `true` if the canonical array is a UTF-8 string type.
pub fn is_utf8_string(canonical: &Canonical) -> bool {
    matches!(canonical,
        Canonical::VarBinView(v) if
            v.dtype().eq_ignore_nullability(&DType::Utf8(Nullability::NonNullable))
    )
}

mod dict;

pub use dict::FloatDictScheme;
pub use dict::IntDictScheme;
pub use dict::StringDictScheme;
pub use dict::float_dictionary_encode;
pub use dict::integer_dictionary_encode;

mod constant;

pub use constant::BoolConstantScheme;
pub use constant::FloatConstantScheme;
pub use constant::IntConstantScheme;
pub use constant::StringConstantScheme;