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 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;
32mod encoding;
33pub mod executor;
34pub mod iter;
35mod mask_future;
36mod metadata;
37pub mod operator;
38mod partial_ord;
39pub mod patches;
40pub mod pipeline;
41pub mod search_sorted;
42pub mod serde;
43pub mod stats;
44pub mod stream;
45#[cfg(any(test, feature = "test-harness"))]
46pub mod test_harness;
47pub mod validity;
48pub mod variants;
49pub mod vtable;
50
51pub mod flatbuffers {
52    //! Re-exported autogenerated code from the core Vortex flatbuffer definitions.
53    pub use vortex_flatbuffers::array::*;
54}