vortex-array 0.81.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

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

use smallvec::smallvec;
use vortex_error::VortexResult;

use crate::ArrayRef;
use crate::array::Array;
use crate::array::ArrayParts;
use crate::array::EmptyArrayData;
use crate::array::TypedArrayRef;
use crate::array_slots;
use crate::arrays::PiecewiseSequence;
use crate::dtype::PType;

#[array_slots(PiecewiseSequence)]
pub struct PiecewiseSequenceSlots {
    /// The inclusive start index of each sequential piece.
    pub starts: ArrayRef,
    /// The length of each sequential piece.
    pub lengths: ArrayRef,
    /// The distance between consecutive indices in each piece.
    pub multipliers: ArrayRef,
}

/// Extension methods for [`Array`] values using the [`PiecewiseSequence`] encoding.
pub trait PiecewiseSequenceArrayExt:
    TypedArrayRef<PiecewiseSequence> + PiecewiseSequenceArraySlotsExt
{
}
impl<T: TypedArrayRef<PiecewiseSequence>> PiecewiseSequenceArrayExt for T {}

impl Array<PiecewiseSequence> {
    /// Constructs a new `PiecewiseSequenceArray` from start, length, and multiplier arrays.
    ///
    /// This validates only structural invariants: all children must be non-nullable unsigned
    /// integer arrays with matching lengths, and the outer array length is the declared expanded
    /// index length. Individual ranges are checked when the index array is executed or consumed by
    /// a take implementation.
    pub fn try_new(
        starts: ArrayRef,
        lengths: ArrayRef,
        multipliers: ArrayRef,
        len: usize,
    ) -> VortexResult<Self> {
        Array::try_from_parts(
            ArrayParts::new(PiecewiseSequence, PType::U64.into(), len, EmptyArrayData)
                .with_slots(smallvec![Some(starts), Some(lengths), Some(multipliers)]),
        )
    }

    /// Constructs a new `PiecewiseSequenceArray` without validation.
    ///
    /// # Safety
    ///
    /// The caller must guarantee the same structural invariants as [`Self::try_new`].
    pub unsafe fn new_unchecked(
        starts: ArrayRef,
        lengths: ArrayRef,
        multipliers: ArrayRef,
        len: usize,
    ) -> Self {
        unsafe {
            Array::from_parts_unchecked(
                ArrayParts::new(PiecewiseSequence, PType::U64.into(), len, EmptyArrayData)
                    .with_slots(smallvec![Some(starts), Some(lengths), Some(multipliers)]),
            )
        }
    }
}