vortex_array/
lib.rs

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