vortex-array 0.92.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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

use std::hash::Hasher;

use num_traits::AsPrimitive;
use prost::Message;
use smallvec::smallvec;
use vortex_error::VortexResult;
use vortex_error::vortex_bail;
use vortex_error::vortex_ensure_eq;
use vortex_error::vortex_err;
use vortex_error::vortex_panic;
use vortex_mask::AllOr;
use vortex_mask::Mask;
use vortex_session::VortexSession;
use vortex_session::registry::CachedId;

use super::DictData;
use super::DictMetadata;
use super::DictOwnedExt;
use super::DictParts;
use super::array::DictSlots;
use super::array::DictSlotsView;
use crate::AnyCanonical;
use crate::ArrayEq;
use crate::ArrayHash;
use crate::ArrayRef;
use crate::Canonical;
use crate::CanonicalView;
use crate::EqMode;
use crate::IntoArray;
use crate::array::Array;
use crate::array::ArrayId;
use crate::array::ArrayParts;
use crate::array::ArrayView;
use crate::array::VTable;
use crate::array::with_empty_buffers;
use crate::arrays::ConstantArray;
use crate::arrays::Primitive;
use crate::arrays::PrimitiveArray;
use crate::arrays::VarBinView;
use crate::arrays::dict::DictArrayExt;
use crate::arrays::dict::DictArraySlotsExt;
use crate::arrays::dict::compute::rules::PARENT_RULES;
use crate::arrays::dict::execute::take_canonical;
use crate::buffer::BufferHandle;
use crate::builders::ArrayBuilder;
use crate::builders::VarBinBuilder;
use crate::builders::VarBinViewBuilder;
use crate::dtype::DType;
use crate::dtype::Nullability;
use crate::dtype::OffsetBuilderPType;
use crate::dtype::PType;
use crate::executor::ExecutionCtx;
use crate::executor::ExecutionResult;
use crate::match_each_integer_ptype;
use crate::match_each_varbin_builder;
use crate::require_child;
use crate::scalar::Scalar;
use crate::serde::ArrayChildren;

mod kernel;
mod operations;
mod validity;

/// A [`Dict`]-encoded Vortex array.
pub type DictArray = Array<Dict>;

pub(crate) fn initialize(session: &VortexSession) {
    kernel::initialize(session);
}

#[derive(Clone, Debug)]
pub struct Dict;

impl ArrayHash for DictData {
    fn array_hash<H: Hasher>(&self, _state: &mut H, _accuracy: EqMode) {}
}

impl ArrayEq for DictData {
    fn array_eq(&self, _other: &Self, _accuracy: EqMode) -> bool {
        true
    }
}

impl VTable for Dict {
    type TypedArrayData = DictData;

    type OperationsVTable = Self;
    type ValidityVTable = Self;

    fn id(&self) -> ArrayId {
        static ID: CachedId = CachedId::new("vortex.dict");
        *ID
    }

    fn validate(
        &self,
        _data: &DictData,
        dtype: &DType,
        len: usize,
        slots: &[Option<ArrayRef>],
    ) -> VortexResult<()> {
        let view = DictSlotsView::from_slots(slots);
        let codes = view.codes;
        let values = view.values;
        vortex_ensure_eq!(codes.len(), len, "DictArray codes length mismatch");
        vortex_ensure_eq!(
            values
                .dtype()
                .union_nullability(codes.dtype().nullability()),
            *dtype,
            "DictArray dtype does not match codes/values dtype",
        );
        Ok(())
    }

    fn nbuffers(_array: ArrayView<'_, Self>) -> usize {
        0
    }

    fn buffer(_array: ArrayView<'_, Self>, idx: usize) -> BufferHandle {
        vortex_panic!("DictArray buffer index {idx} out of bounds")
    }

    fn buffer_name(_array: ArrayView<'_, Self>, _idx: usize) -> Option<String> {
        None
    }

    fn with_buffers(
        &self,
        array: ArrayView<'_, Self>,
        buffers: &[BufferHandle],
    ) -> VortexResult<ArrayParts<Self>> {
        with_empty_buffers(self, array, buffers)
    }

    fn serialize(
        array: ArrayView<'_, Self>,
        _session: &VortexSession,
    ) -> VortexResult<Option<Vec<u8>>> {
        Ok(Some(
            DictMetadata {
                codes_ptype: PType::try_from(array.codes().dtype())? as i32,
                values_len: u32::try_from(array.values().len()).map_err(|_| {
                    vortex_err!(
                        "Dictionary values size {} overflowed u32",
                        array.values().len()
                    )
                })?,
                is_nullable_codes: Some(array.codes().dtype().is_nullable()),
                all_values_referenced: Some(array.has_all_values_referenced()),
            }
            .encode_to_vec(),
        ))
    }

    fn deserialize(
        &self,
        dtype: &DType,
        len: usize,
        metadata: &[u8],
        _buffers: &[BufferHandle],
        children: &dyn ArrayChildren,
        _session: &VortexSession,
    ) -> VortexResult<ArrayParts<Self>> {
        let metadata = DictMetadata::decode(metadata)?;
        let codes_ptype = metadata.get_codes_ptype()?;
        if children.len() != 2 {
            vortex_bail!(
                "Expected 2 children for dict encoding, found {}",
                children.len()
            )
        }
        let codes_nullable = metadata
            .is_nullable_codes
            .map(Nullability::from)
            // If no `is_nullable_codes` metadata use the nullability of the values
            // (and whole array) as before.
            .unwrap_or_else(|| dtype.nullability());
        let codes_dtype = DType::Primitive(codes_ptype, codes_nullable);
        let codes = children.get(0, &codes_dtype, len)?;
        let values = children.get(1, dtype, metadata.values_len as usize)?;
        let all_values_referenced = metadata.all_values_referenced.unwrap_or(false);

        Ok(ArrayParts::new(
            self.clone(),
            dtype.clone(),
            len,
            unsafe { DictData::new_unchecked().set_all_values_referenced(all_values_referenced) },
            smallvec![Some(codes), Some(values)],
        ))
    }

    fn slot_name(_array: ArrayView<'_, Self>, idx: usize) -> String {
        DictSlots::NAMES[idx].to_string()
    }

    fn execute(array: Array<Self>, ctx: &mut ExecutionCtx) -> VortexResult<ExecutionResult> {
        if array.is_empty() {
            let result_dtype = array
                .dtype()
                .union_nullability(array.codes().dtype().nullability());
            return Ok(ExecutionResult::done(Canonical::empty(&result_dtype)));
        }

        let array = require_child!(array, array.codes(), DictSlots::CODES => Primitive);

        if array.codes().validity()?.definitely_all_null() {
            return Ok(ExecutionResult::done(ConstantArray::new(
                Scalar::null(array.dtype().as_nullable()),
                array.codes().len(),
            )));
        }

        let array = require_child!(array, array.values(), DictSlots::VALUES => AnyCanonical);

        let DictParts { values, codes, .. } = array.into_parts();

        Ok(ExecutionResult::done(take_canonical(
            values.as_::<AnyCanonical>(),
            codes.as_::<Primitive>(),
            ctx,
        )?))
    }

    fn append_to_builder(
        array: ArrayView<'_, Self>,
        builder: &mut dyn ArrayBuilder,
        ctx: &mut ExecutionCtx,
    ) -> VortexResult<()> {
        if !array.is_empty() {
            let codes = array.codes().clone().execute::<PrimitiveArray>(ctx)?;
            if !codes.validity()?.definitely_all_null() {
                let values = array.values();
                if array.len() <= values.len() / 4
                    && matches!(array.dtype(), DType::Utf8(_) | DType::Binary(_))
                    && !values.is::<AnyCanonical>()
                {
                    // A sparse selection reaches the take kernel of the values, such as the OnPair
                    // token-run gather, before the whole dictionary is decoded.
                    // SAFETY: executing the codes keeps their values, dtype and length.
                    let taken =
                        unsafe { DictArray::new_unchecked(codes.into_array(), values.clone()) };
                    let canonical = taken.into_array().execute::<Canonical>(ctx)?.into_array();
                    return canonical.append_to_builder(builder, ctx);
                }

                // Decode the children without taking values to the full row count. The
                // variable-binary builders gather directly through these dictionary codes.
                let values = if array.values().is::<AnyCanonical>() {
                    array.values().clone()
                } else {
                    array
                        .values()
                        .clone()
                        .execute::<Canonical>(ctx)?
                        .into_array()
                };
                let values = values.as_::<AnyCanonical>();
                let codes = codes.as_view();
                if let CanonicalView::VarBinView(values) = values
                    && let Some(result) = match_each_varbin_builder!(builder, |builder| {
                        let validity = array.validity()?.execute_mask(array.len(), ctx)?;
                        append_dict_to_varbin(codes, values, validity, builder)
                    })
                {
                    return result;
                }
                if let CanonicalView::VarBinView(values) = values
                    && let Some(builder) = builder.as_any_mut().downcast_mut::<VarBinViewBuilder>()
                {
                    let validity = array.validity()?.execute_mask(array.len(), ctx)?;
                    return append_dict_to_varbinview(codes, values, validity, builder);
                }
                let canonical = take_canonical(values, codes, ctx)?.into_array();
                canonical.append_to_builder(builder, ctx)?;
                return Ok(());
            }
        }

        let canonical = array
            .array()
            .clone()
            .execute::<Canonical>(ctx)?
            .into_array();
        canonical.append_to_builder(builder, ctx)?;
        Ok(())
    }

    fn reduce_parent(
        array: ArrayView<'_, Self>,
        parent: &ArrayRef,
        child_idx: usize,
    ) -> VortexResult<Option<ArrayRef>> {
        PARENT_RULES.evaluate(array, parent, child_idx)
    }
}

/// Gathers the dictionary values straight into `builder` as views.
///
/// The canonical route first takes the values to full logical length — allocating an intermediate
/// views buffer proportional to the row count — and then `append_varbinview_array` walks all
/// those views a second time to rebase their buffer indices onto the builder's. Gathering through
/// the codes directly instead adopts the dictionary's buffers once (deduplicated across chunks
/// sharing the dictionary, when the builder deduplicates) and writes each row's rebased view in a
/// single pass, with no byte copy at all.
fn append_dict_to_varbinview(
    codes: ArrayView<'_, Primitive>,
    values: ArrayView<'_, VarBinView>,
    validity: Mask,
    builder: &mut VarBinViewBuilder,
) -> VortexResult<()> {
    let views = values.views();
    let buffers = values
        .data_buffers()
        .iter()
        .map(|buffer| buffer.as_host().clone())
        .collect::<Vec<_>>();

    match_each_integer_ptype!(codes.ptype(), |C| {
        let codes = codes.as_slice::<C>();
        builder.append_views_gathered(buffers, views, &validity, |row| {
            AsPrimitive::<usize>::as_(codes[row])
        });
    });
    Ok(())
}

/// Gathers the dictionary values straight into `builder`.
///
/// The canonical route first takes the values to full logical length, which allocates and then
/// re-reads a views buffer proportional to the row count. The dictionary is usually far smaller
/// than the column, so resolving each code against it in place skips that intermediate entirely
/// and leaves one `memcpy` per row as the only work.
fn append_dict_to_varbin<O: OffsetBuilderPType>(
    codes: ArrayView<'_, Primitive>,
    values: ArrayView<'_, VarBinView>,
    validity: Mask,
    builder: &mut VarBinBuilder<O>,
) -> VortexResult<()>
where
    usize: AsPrimitive<O>,
{
    let len = codes.as_ref().len();
    vortex_ensure_eq!(
        validity.len(),
        len,
        "Dictionary gather validity length mismatch"
    );

    // Resolve the dictionary's storage once so that looking up a code is an O(1) read.
    let views = values.views();
    let buffers = values
        .data_buffers()
        .iter()
        .map(|buffer| buffer.as_host().as_slice())
        .collect::<Vec<_>>();

    match_each_integer_ptype!(codes.ptype(), |C| {
        let codes = codes.as_slice::<C>();
        let view = |row: usize| &views[AsPrimitive::<usize>::as_(codes[row])];

        // Both passes below resolve a row through its code, so the byte total comes from the same
        // walk over the valid rows that the copy will make.
        let num_bytes = match validity.bit_buffer() {
            AllOr::All => (0..len).map(|row| view(row).len() as usize).sum(),
            AllOr::None => {
                builder.push_nulls(len);
                return Ok(());
            }
            AllOr::Some(bits) => {
                let mut total = 0;
                bits.for_each_set_index(|row| total += view(row).len() as usize);
                total
            }
        };

        builder.append_valid_slices(num_bytes, &validity, |row| {
            // SAFETY: the byte-count pass checked every selected code against `views`, and
            // append_valid_slices visits exactly those same rows. The slices and validity are
            // immutable, and the length check above bounds every visited row within `codes`.
            let value = unsafe {
                views.get_unchecked(AsPrimitive::<usize>::as_(*codes.get_unchecked(row)))
            };
            value.bytes(&buffers)
        })
    })
}

#[cfg(test)]
mod tests {
    use std::sync::LazyLock;

    use vortex_session::VortexSession;

    use super::*;
    use crate::VortexSessionExecute;
    use crate::arrays::PrimitiveArray;
    use crate::arrays::VarBinViewArray;
    use crate::arrays::dict::DictArray;
    use crate::assert_arrays_eq;
    use crate::dtype::Nullability::Nullable;

    static SESSION: LazyLock<VortexSession> = LazyLock::new(VortexSession::empty);

    const LONG: &str = "a string that is far too long to be inlined in a view";

    #[test]
    fn dictionary_gather_rejects_mismatched_validity() -> VortexResult<()> {
        let ctx = SESSION.create_execution_ctx();
        let codes = PrimitiveArray::from_iter([0u8, 1]);
        let values = VarBinViewArray::from_iter([Some("one"), Some("two")], DType::Utf8(Nullable));
        let mut builder = VarBinBuilder::<i32>::new_in(DType::Utf8(Nullable), ctx.allocator());
        let result = append_dict_to_varbin(
            codes.as_view(),
            values.as_view(),
            Mask::new_true(3),
            &mut builder,
        );
        assert!(result.is_err());
        assert_eq!(builder.len(), 0);
        Ok(())
    }

    #[test]
    fn dictionary_gather_does_not_read_null_row_codes() -> VortexResult<()> {
        let mut ctx = SESSION.create_execution_ctx();
        let codes = PrimitiveArray::from_iter([0u8, 255, 1]);
        let values = VarBinViewArray::from_iter([Some("one"), Some("two")], DType::Utf8(Nullable));
        let mut builder = VarBinBuilder::<i32>::new_in(DType::Utf8(Nullable), ctx.allocator());
        append_dict_to_varbin(
            codes.as_view(),
            values.as_view(),
            Mask::from_iter([true, false, true]),
            &mut builder,
        )?;
        let expected =
            VarBinViewArray::from_iter([Some("one"), None, Some("two")], DType::Utf8(Nullable));
        assert_arrays_eq!(builder.finish_into_varbin(), expected, &mut ctx);
        Ok(())
    }

    #[test]
    #[should_panic(expected = "index out of bounds")]
    fn dictionary_gather_checks_selected_codes_before_copy() {
        let ctx = SESSION.create_execution_ctx();
        let codes = PrimitiveArray::from_iter([0u8, 255]);
        let values = VarBinViewArray::from_iter([Some("one")], DType::Utf8(Nullable));
        let mut builder = VarBinBuilder::<i32>::new_in(DType::Utf8(Nullable), ctx.allocator());
        drop(append_dict_to_varbin(
            codes.as_view(),
            values.as_view(),
            Mask::new_true(2),
            &mut builder,
        ));
    }

    #[test]
    fn append_to_builder_gathers_through_the_dictionary() -> VortexResult<()> {
        let mut ctx = SESSION.create_execution_ctx();
        let dict = DictArray::try_new(
            PrimitiveArray::from_option_iter([Some(0u32), Some(2), None, Some(1), Some(0)])
                .into_array(),
            VarBinViewArray::from_iter([Some(LONG), None, Some("short")], DType::Utf8(Nullable))
                .into_array(),
        )?;

        let mut builder = VarBinBuilder::<i32>::new_in(DType::Utf8(Nullable), ctx.allocator());
        dict.append_to_builder(&mut builder, &mut ctx)?;

        let expected = VarBinViewArray::from_iter(
            [Some(LONG), Some("short"), None, None, Some(LONG)],
            DType::Utf8(Nullable),
        );
        assert_arrays_eq!(builder.finish_into_varbin(), expected, &mut ctx);
        Ok(())
    }

    /// The view-builder path gathers views through the codes without materializing the taken
    /// array, so the result must still match the canonical take — including rows whose code is
    /// null and rows whose dictionary value is null.
    #[test]
    fn append_to_view_builder_gathers_through_the_dictionary() -> VortexResult<()> {
        let mut ctx = SESSION.create_execution_ctx();
        let dict = DictArray::try_new(
            PrimitiveArray::from_option_iter([Some(0u32), Some(2), None, Some(1), Some(0)])
                .into_array(),
            VarBinViewArray::from_iter([Some(LONG), None, Some("short")], DType::Utf8(Nullable))
                .into_array(),
        )?;

        let mut builder = VarBinViewBuilder::with_capacity_in(
            DType::Utf8(Nullable),
            8,
            vortex_buffer::BufferAllocatorRef::statically_allocated(),
        );
        builder.append_value(LONG);
        dict.append_to_builder(&mut builder, &mut ctx)?;

        let expected = VarBinViewArray::from_iter(
            [
                Some(LONG),
                Some(LONG),
                Some("short"),
                None,
                None,
                Some(LONG),
            ],
            DType::Utf8(Nullable),
        );
        assert_arrays_eq!(builder.finish_into_varbinview(), expected, &mut ctx);
        Ok(())
    }

    /// Two chunks gathered through the same dictionary into a deduplicating builder must adopt
    /// the dictionary's data buffers once.
    #[test]
    fn append_to_dedup_view_builder_adopts_the_dictionary_once() -> VortexResult<()> {
        let mut ctx = SESSION.create_execution_ctx();
        let values = VarBinViewArray::from_iter([Some(LONG), Some("short")], DType::Utf8(Nullable));
        assert_eq!(values.data_buffers().len(), 1);

        let first = DictArray::try_new(
            PrimitiveArray::from_option_iter([Some(0u32), Some(1)]).into_array(),
            values.clone().into_array(),
        )?;
        let second = DictArray::try_new(
            PrimitiveArray::from_option_iter([Some(1u32), Some(0)]).into_array(),
            values.into_array(),
        )?;

        let mut builder = VarBinViewBuilder::with_buffer_deduplication_in(
            DType::Utf8(Nullable),
            8,
            vortex_buffer::BufferAllocatorRef::statically_allocated(),
        );
        first.append_to_builder(&mut builder, &mut ctx)?;
        second.append_to_builder(&mut builder, &mut ctx)?;
        assert_eq!(builder.completed_block_count(), 1);

        let expected = VarBinViewArray::from_iter(
            [Some(LONG), Some("short"), Some("short"), Some(LONG)],
            DType::Utf8(Nullable),
        );
        assert_arrays_eq!(builder.finish_into_varbinview(), expected, &mut ctx);
        Ok(())
    }
}