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](vtable::ArrayVTable).
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 hash::*;
19pub use mask_future::*;
20pub use metadata::*;
21
22pub mod accessor;
23#[doc(hidden)]
24pub mod aliases;
25mod array;
26pub mod arrays;
27pub mod arrow;
28pub mod builders;
29mod canonical;
30pub mod compute;
31mod context;
32pub mod display;
33pub mod execution;
34pub mod expr;
35mod hash;
36pub mod iter;
37mod mask_future;
38mod metadata;
39pub mod optimizer;
40mod partial_ord;
41pub mod patches;
42pub mod scalar_fns;
43pub mod search_sorted;
44pub mod serde;
45pub mod session;
46pub mod stats;
47pub mod stream;
48#[cfg(any(test, feature = "test-harness"))]
49pub mod test_harness;
50pub mod validity;
51pub mod variants;
52pub mod vectors;
53pub mod vtable;
54
55pub mod flatbuffers {
56    //! Re-exported autogenerated code from the core Vortex flatbuffer definitions.
57    pub use vortex_flatbuffers::array::*;
58}