vortex-onpair 0.78.0

Vortex OnPair string array encoding (dict-12, pushdown predicates)
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

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

//! Vortex string array backed by the [OnPair][onpair] short-string
//! compression library, with `cast` and `filter` pushdown.
//!
//! The default training preset is `dict-12` (12 bits per token, dictionary
//! capped at 4 096 entries). See [`onpair_compress`] for the entry point and
//! [`OnPairArray`] for the resulting array type.
//!
//! [onpair]: https://arxiv.org/abs/2508.02280

mod array;
mod canonical;
mod compress;
mod compute;
mod decode;
mod kernel;
mod ops;
mod rules;
#[cfg(test)]
mod tests;

pub use array::*;
pub use compress::*;
pub use onpair::Bits;
pub use onpair::Config;
pub use onpair::Error as OnPairError;
pub use onpair::Threshold;
use vortex_array::session::ArraySessionExt;
use vortex_session::VortexSession;

/// Initialize OnPair encoding in the given session.
pub fn initialize(session: &VortexSession) {
    session.arrays().register(OnPair);
    kernel::initialize(session);
}