vortex-array 0.76.0

Vortex in memory columnar data format
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

//! Built-in array encodings.
//!
//! Canonical arrays are the default uncompressed representation for a logical dtype:
//! [`NullArray`], [`BoolArray`], [`PrimitiveArray`], [`DecimalArray`], [`VarBinViewArray`],
//! [`ListViewArray`], [`FixedSizeListArray`], [`StructArray`], [`ExtensionArray`], and
//! [`VariantArray`].
//!
//! Utility and lazy arrays represent common transformations without immediately materializing
//! their result. Examples include [`ChunkedArray`] for concatenation, [`ConstantArray`] for repeated
//! values, [`DictArray`] for dictionary encoding, [`FilterArray`] for masked rows, [`SliceArray`]
//! for views, and [`ScalarFnArray`] for deferred scalar-function execution.
//!
//! Some public arrays are primarily internal building blocks. Their constructors and extension
//! traits document the stable contract; avoid depending on undocumented slot order or metadata
//! details.

#[cfg(any(test, feature = "_test-harness"))]
mod assertions;

#[cfg(any(test, feature = "_test-harness"))]
pub use assertions::assert_arrays_eq_impl;

#[cfg(test)]
mod validation_tests;

#[cfg(any(test, feature = "_test-harness"))]
pub mod dict_test;

pub mod bool;
pub use bool::Bool;
pub use bool::BoolArray;

pub mod chunked;
pub use chunked::Chunked;
pub use chunked::ChunkedArray;

pub mod constant;
pub use constant::Constant;
pub use constant::ConstantArray;

pub mod datetime;
pub use datetime::TemporalArray;

pub mod decimal;
pub use decimal::Decimal;
pub use decimal::DecimalArray;

pub mod dict;
pub use dict::Dict;
pub use dict::DictArray;

pub mod extension;
pub use extension::Extension;
pub use extension::ExtensionArray;

pub mod filter;
pub use filter::Filter;
pub use filter::FilterArray;

pub mod fixed_size_list;
pub use fixed_size_list::FixedSizeList;
pub use fixed_size_list::FixedSizeListArray;

pub mod interleave;
pub use interleave::Interleave;
pub use interleave::InterleaveArray;

pub mod list;
pub use list::List;
pub use list::ListArray;

pub mod listview;
pub use listview::ListView;
pub use listview::ListViewArray;

pub mod masked;
pub use masked::Masked;
pub use masked::MaskedArray;

pub mod null;
pub use null::Null;
pub use null::NullArray;

pub mod patched;
pub use patched::Patched;
pub use patched::PatchedArray;

pub mod primitive;
pub use primitive::Primitive;
pub use primitive::PrimitiveArray;

pub mod scalar_fn;
pub use scalar_fn::ScalarFn;
pub use scalar_fn::ScalarFnArray;

pub mod shared;
pub use shared::Shared;
pub use shared::SharedArray;

pub mod slice;
pub use slice::Slice;
pub use slice::SliceArray;

pub mod struct_;
pub use struct_::Struct;
pub use struct_::StructArray;

pub mod varbin;
pub use varbin::VarBin;
pub use varbin::VarBinArray;

pub mod varbinview;
pub use varbinview::VarBinView;
pub use varbinview::VarBinViewArray;

pub mod variant;
pub use variant::Variant;
pub use variant::VariantArray;
use vortex_session::VortexSession;

pub(crate) fn initialize(session: &VortexSession) {
    bool::initialize(session);
    chunked::initialize(session);
    decimal::initialize(session);
    dict::initialize(session);
    extension::initialize(session);
    filter::initialize(session);
    fixed_size_list::initialize(session);
    list::initialize(session);
    listview::initialize(session);
    patched::initialize(session);
    primitive::initialize(session);
    struct_::initialize(session);
    varbin::initialize(session);
    varbinview::initialize(session);
    variant::initialize(session);
}

#[cfg(feature = "arbitrary")]
pub mod arbitrary;