vortex_array/arrays/varbinview/vtable/
mod.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use std::mem::size_of;
5use std::sync::Arc;
6
7use kernel::PARENT_KERNELS;
8use vortex_buffer::Buffer;
9use vortex_dtype::DType;
10use vortex_error::VortexResult;
11use vortex_error::vortex_bail;
12use vortex_error::vortex_err;
13use vortex_session::VortexSession;
14
15use crate::ArrayRef;
16use crate::EmptyMetadata;
17use crate::ExecutionCtx;
18use crate::arrays::BinaryView;
19use crate::arrays::varbinview::VarBinViewArray;
20use crate::arrays::varbinview::compute::rules::PARENT_RULES;
21use crate::buffer::BufferHandle;
22use crate::serde::ArrayChildren;
23use crate::validity::Validity;
24use crate::vtable;
25use crate::vtable::ArrayId;
26use crate::vtable::VTable;
27use crate::vtable::ValidityVTableFromValidityHelper;
28
29mod array;
30mod kernel;
31mod operations;
32mod validity;
33mod visitor;
34
35vtable!(VarBinView);
36
37#[derive(Debug)]
38pub struct VarBinViewVTable;
39
40impl VarBinViewVTable {
41    pub const ID: ArrayId = ArrayId::new_ref("vortex.varbinview");
42}
43
44impl VTable for VarBinViewVTable {
45    type Array = VarBinViewArray;
46
47    type Metadata = EmptyMetadata;
48
49    type ArrayVTable = Self;
50    type OperationsVTable = Self;
51    type ValidityVTable = ValidityVTableFromValidityHelper;
52    type VisitorVTable = Self;
53
54    fn id(_array: &Self::Array) -> ArrayId {
55        Self::ID
56    }
57
58    fn metadata(_array: &VarBinViewArray) -> VortexResult<Self::Metadata> {
59        Ok(EmptyMetadata)
60    }
61
62    fn serialize(_metadata: Self::Metadata) -> VortexResult<Option<Vec<u8>>> {
63        Ok(Some(vec![]))
64    }
65
66    fn deserialize(
67        _bytes: &[u8],
68        _dtype: &DType,
69        _len: usize,
70        _buffers: &[BufferHandle],
71        _session: &VortexSession,
72    ) -> VortexResult<Self::Metadata> {
73        Ok(EmptyMetadata)
74    }
75
76    fn build(
77        dtype: &DType,
78        len: usize,
79        _metadata: &Self::Metadata,
80        buffers: &[BufferHandle],
81        children: &dyn ArrayChildren,
82    ) -> VortexResult<VarBinViewArray> {
83        let Some((views_handle, data_handles)) = buffers.split_last() else {
84            vortex_bail!("Expected at least 1 buffer, got 0");
85        };
86
87        let validity = if children.is_empty() {
88            Validity::from(dtype.nullability())
89        } else if children.len() == 1 {
90            let validity = children.get(0, &Validity::DTYPE, len)?;
91            Validity::Array(validity)
92        } else {
93            vortex_bail!("Expected 0 or 1 children, got {}", children.len());
94        };
95
96        let views_nbytes = views_handle.len();
97        let expected_views_nbytes = len
98            .checked_mul(size_of::<BinaryView>())
99            .ok_or_else(|| vortex_err!("views byte length overflow for len={len}"))?;
100        if views_nbytes != expected_views_nbytes {
101            vortex_bail!(
102                "Expected views buffer length {} bytes, got {} bytes",
103                expected_views_nbytes,
104                views_nbytes
105            );
106        }
107
108        // If any buffer is on device, skip host validation and use try_new_handle.
109        if buffers.iter().any(|b| b.is_on_device()) {
110            return VarBinViewArray::try_new_handle(
111                views_handle.clone(),
112                Arc::from(data_handles.to_vec()),
113                dtype.clone(),
114                validity,
115            );
116        }
117
118        let data_buffers = data_handles
119            .iter()
120            .map(|b| b.as_host().clone())
121            .collect::<Vec<_>>();
122        let views = Buffer::<BinaryView>::from_byte_buffer(views_handle.clone().as_host().clone());
123
124        VarBinViewArray::try_new(views, Arc::from(data_buffers), dtype.clone(), validity)
125    }
126
127    fn with_children(array: &mut Self::Array, children: Vec<ArrayRef>) -> VortexResult<()> {
128        match children.len() {
129            0 => {}
130            1 => {
131                let [validity]: [ArrayRef; 1] = children
132                    .try_into()
133                    .map_err(|_| vortex_err!("Failed to convert children to array"))?;
134                array.validity = Validity::Array(validity);
135            }
136            _ => vortex_bail!(
137                "VarBinViewArray expects 0 or 1 children (validity?), got {}",
138                children.len()
139            ),
140        }
141        Ok(())
142    }
143
144    fn reduce_parent(
145        array: &Self::Array,
146        parent: &ArrayRef,
147        child_idx: usize,
148    ) -> VortexResult<Option<ArrayRef>> {
149        PARENT_RULES.evaluate(array, parent, child_idx)
150    }
151
152    fn execute_parent(
153        array: &Self::Array,
154        parent: &ArrayRef,
155        child_idx: usize,
156        ctx: &mut ExecutionCtx,
157    ) -> VortexResult<Option<ArrayRef>> {
158        PARENT_KERNELS.execute(array, parent, child_idx, ctx)
159    }
160
161    fn execute(array: &Self::Array, _ctx: &mut ExecutionCtx) -> VortexResult<ArrayRef> {
162        Ok(array.to_array())
163    }
164}
vortex_array/arrays/varbinview/vtable/mod.rs

vortex_array/arrays/varbinview/vtable/
mod.rs
