vortex-fsst 0.76.0

Vortex FSST string array encoding
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

//! An array that uses the [Fast Static Symbol Table][fsst] compression scheme
//! to compress string arrays.
//!
//! FSST arrays can generally compress string data up to 2x through the use of
//! string tables. The string table is static for an entire array, and occupies
//! up to 2048 bytes of buffer space. Thus, FSST is only worth reaching for when
//! dealing with larger arrays of potentially hundreds of kilobytes or more.
//!
//! [fsst]: https://www.vldb.org/pvldb/vol13/p2649-boncz.pdf

mod array;
mod canonical;
mod compress;
mod compute;
mod dfa;
mod kernel;
mod ops;
mod rules;
mod slice;
#[cfg(feature = "_test-harness")]
pub mod test_utils;
#[cfg(test)]
mod tests;

pub use array::*;
pub use compress::*;
use vortex_array::session::ArraySessionExt;
use vortex_session::VortexSession;

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