vortex-array 0.22.1

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

//! Metadata serialization tests for all builtin array types.
//!
//! This test suite checks for when metadata format changes for one of the core
//! encodings.
//!
//! These tests can be run as normal using `cargo test`. Failures will occur when the serialization
//! format of any encoding metadata changes.
//!
//! You can update the stored "golden files" by re-running your test command with the
//! `UPDATE_GOLDENFILES=1` environment variable. For example:
//!
//! ```ignored
//! $ UPDATE_GOLDENFILES=1 cargo test -p vortex-array --tests test_compatibility
//! ````

use vortex_dtype::{Nullability, PType};
use vortex_scalar::Scalar;

use crate::array::{
    BoolMetadata, ChunkedMetadata, ConstantMetadata, ListMetadata, NullMetadata, PrimitiveMetadata,
    SparseMetadata, StructMetadata, VarBinMetadata, VarBinViewMetadata,
};
use crate::patches::PatchesMetadata;
use crate::test_harness::check_metadata;
use crate::validity::ValidityMetadata;

#[cfg_attr(miri, ignore)]
#[test]
fn test_bool_metadata() {
    check_metadata(
        "bool.metadata",
        BoolMetadata {
            validity: ValidityMetadata::AllValid,
            first_byte_bit_offset: u8::MAX,
        },
    );
}

#[cfg_attr(miri, ignore)]
#[test]
fn test_chunked_metadata() {
    check_metadata("chunked.metadata", ChunkedMetadata { nchunks: 1 });
}

#[cfg_attr(miri, ignore)]
#[test]
fn test_constant_metadata() {
    check_metadata(
        "constant.metadata",
        ConstantMetadata {
            scalar_value: Scalar::primitive(i32::MAX, Nullability::Nullable).into_value(),
        },
    );
}

#[cfg_attr(miri, ignore)]
#[test]
fn test_list_metadata() {
    check_metadata(
        "list.metadata",
        ListMetadata {
            validity: ValidityMetadata::AllValid,
            elements_len: usize::MAX,
            offset_ptype: PType::U64,
        },
    );
}

#[cfg_attr(miri, ignore)]
#[test]
fn test_null_metadata() {
    check_metadata("null.metadata", NullMetadata);
}

#[cfg_attr(miri, ignore)]
#[test]
fn test_primitive_metadata() {
    check_metadata(
        "primitive.metadata",
        PrimitiveMetadata {
            validity: ValidityMetadata::NonNullable,
        },
    );
}

#[cfg_attr(miri, ignore)]
#[test]
fn test_sparse_metadata() {
    check_metadata(
        "sparse.metadata",
        SparseMetadata {
            fill_value: Scalar::primitive(i32::MAX, Nullability::NonNullable).into_value(),
            patches: PatchesMetadata::new(usize::MAX, PType::U64),
            indices_offset: usize::MAX,
        },
    );
}

#[cfg_attr(miri, ignore)]
#[test]
fn test_struct_metadata() {
    check_metadata(
        "struct.metadata",
        StructMetadata {
            validity: ValidityMetadata::AllValid,
        },
    );
}

#[cfg_attr(miri, ignore)]
#[test]
fn test_varbin_metadata() {
    check_metadata(
        "varbin.metadata",
        VarBinMetadata {
            validity: ValidityMetadata::AllValid,
            bytes_len: usize::MAX,
            offsets_ptype: PType::U64,
        },
    );
}

#[cfg_attr(miri, ignore)]
#[test]
fn test_varbinview_metadata() {
    check_metadata(
        "varbinview.metadata",
        VarBinViewMetadata {
            buffer_lens: vec![1, 2, 3, 4],
            validity: ValidityMetadata::AllValid,
        },
    );
}