vortex_array/arrays/
mod.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4//! Built-in array encodings.
5//!
6//! Canonical arrays are the default uncompressed representation for a logical dtype:
7//! [`NullArray`], [`BoolArray`], [`PrimitiveArray`], [`DecimalArray`], [`VarBinViewArray`],
8//! [`ListViewArray`], [`FixedSizeListArray`], [`StructArray`], [`ExtensionArray`], and
9//! [`VariantArray`].
10//!
11//! Utility and lazy arrays represent common transformations without immediately materializing
12//! their result. Examples include [`ChunkedArray`] for concatenation, [`ConstantArray`] for repeated
13//! values, [`DictArray`] for dictionary encoding, [`FilterArray`] for masked rows, [`SliceArray`]
14//! for views, and [`ScalarFnArray`] for deferred scalar-function execution.
15//!
16//! Some public arrays are primarily internal building blocks. Their constructors and extension
17//! traits document the stable contract; avoid depending on undocumented slot order or metadata
18//! details.
19
20#[cfg(any(test, feature = "_test-harness"))]
21mod assertions;
22
23#[cfg(any(test, feature = "_test-harness"))]
24pub use assertions::assert_arrays_eq_impl;
25
26#[cfg(test)]
27mod validation_tests;
28
29#[cfg(any(test, feature = "_test-harness"))]
30pub mod dict_test;
31
32pub mod bool;
33pub use bool::Bool;
34pub use bool::BoolArray;
35
36pub mod chunked;
37pub use chunked::Chunked;
38pub use chunked::ChunkedArray;
39
40pub mod constant;
41pub use constant::Constant;
42pub use constant::ConstantArray;
43
44pub mod datetime;
45pub use datetime::TemporalArray;
46
47pub mod decimal;
48pub use decimal::Decimal;
49pub use decimal::DecimalArray;
50
51pub mod dict;
52pub use dict::Dict;
53pub use dict::DictArray;
54
55pub mod extension;
56pub use extension::Extension;
57pub use extension::ExtensionArray;
58
59pub mod filter;
60pub use filter::Filter;
61pub use filter::FilterArray;
62
63pub mod fixed_size_list;
64pub use fixed_size_list::FixedSizeList;
65pub use fixed_size_list::FixedSizeListArray;
66
67pub mod interleave;
68pub use interleave::Interleave;
69pub use interleave::InterleaveArray;
70
71pub mod list;
72pub use list::List;
73pub use list::ListArray;
74
75pub mod listview;
76pub use listview::ListView;
77pub use listview::ListViewArray;
78
79pub mod masked;
80pub use masked::Masked;
81pub use masked::MaskedArray;
82
83pub mod null;
84pub use null::Null;
85pub use null::NullArray;
86
87pub mod patched;
88pub use patched::Patched;
89pub use patched::PatchedArray;
90
91pub mod piecewise_sequence;
92pub use piecewise_sequence::PiecewiseSequence;
93pub use piecewise_sequence::PiecewiseSequenceArray;
94
95pub mod primitive;
96pub use primitive::Primitive;
97pub use primitive::PrimitiveArray;
98
99pub mod scalar_fn;
100pub use scalar_fn::ScalarFn;
101pub use scalar_fn::ScalarFnArray;
102
103pub mod shared;
104pub use shared::Shared;
105pub use shared::SharedArray;
106
107pub mod slice;
108pub use slice::Slice;
109pub use slice::SliceArray;
110
111pub mod struct_;
112pub use struct_::Struct;
113pub use struct_::StructArray;
114
115pub mod varbin;
116pub use varbin::VarBin;
117pub use varbin::VarBinArray;
118
119pub mod varbinview;
120pub use varbinview::VarBinView;
121pub use varbinview::VarBinViewArray;
122
123pub mod variant;
124pub use variant::Variant;
125pub use variant::VariantArray;
126use vortex_session::VortexSession;
127
128pub(crate) fn initialize(session: &VortexSession) {
129    bool::initialize(session);
130    chunked::initialize(session);
131    decimal::initialize(session);
132    dict::initialize(session);
133    extension::initialize(session);
134    filter::initialize(session);
135    fixed_size_list::initialize(session);
136    list::initialize(session);
137    listview::initialize(session);
138    patched::initialize(session);
139    primitive::initialize(session);
140    struct_::initialize(session);
141    varbin::initialize(session);
142    varbinview::initialize(session);
143    variant::initialize(session);
144}
145
146#[cfg(feature = "arbitrary")]
147pub mod arbitrary;
vortex_array/arrays/mod.rs

vortex_array/arrays/
mod.rs
