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