vortex_array/
lib.rs

1//! Vortex crate containing core logic for encoding and memory representation of [arrays](ArrayRef).
2//!
3//! At the heart of Vortex are [arrays](ArrayRef) and [encodings](EncodingRef).
4//! Arrays are typed views of memory buffers that hold [scalars](vortex_scalar::Scalar). These
5//! buffers can be held in a number of physical encodings to perform lightweight compression that
6//! exploits the particular data distribution of the array's values.
7//!
8//! Every data type recognized by Vortex also has a canonical physical encoding format, which
9//! arrays can be [canonicalized](Canonical) into for ease of access in compute functions.
10
11#![cfg_attr(feature = "nightly", feature(portable_simd))]
12
13pub use array::*;
14pub use canonical::*;
15pub use context::*;
16pub use encoding::*;
17pub use metadata::*;
18
19pub mod accessor;
20pub mod aliases;
21mod array;
22pub mod arrays;
23pub mod arrow;
24pub mod builders;
25mod canonical;
26pub mod compress;
27pub mod compute;
28mod context;
29pub mod data;
30mod encoding;
31pub mod iter;
32mod metadata;
33mod partial_ord;
34pub mod patches;
35pub mod search_sorted;
36pub mod serde;
37pub mod stats;
38pub mod stream;
39#[cfg(feature = "test-harness")]
40pub mod test_harness;
41mod tree;
42pub mod validity;
43pub mod variants;
44pub mod vtable;
45
46pub mod flatbuffers {
47    //! Re-exported autogenerated code from the core Vortex flatbuffer definitions.
48    pub use vortex_flatbuffers::array::*;
49}