vortex_array/arrays/constant/
mod.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use vortex_buffer::ByteBufferMut;
5use vortex_dtype::DType;
6use vortex_error::VortexResult;
7use vortex_mask::Mask;
8use vortex_scalar::Scalar;
9
10use crate::stats::{ArrayStats, StatsSetRef};
11use crate::vtable::{
12    ArrayVTable, NotSupported, OperationsVTable, VTable, ValidityVTable, VisitorVTable,
13};
14use crate::{
15    ArrayBufferVisitor, ArrayChildVisitor, ArrayRef, EncodingId, EncodingRef, IntoArray, vtable,
16};
17
18mod canonical;
19mod compute;
20mod encode;
21mod serde;
22
23vtable!(Constant);
24
25#[derive(Clone, Debug)]
26pub struct ConstantArray {
27    scalar: Scalar,
28    len: usize,
29    stats_set: ArrayStats,
30}
31
32#[derive(Clone, Debug)]
33pub struct ConstantEncoding;
34
35impl VTable for ConstantVTable {
36    type Array = ConstantArray;
37    type Encoding = ConstantEncoding;
38
39    type ArrayVTable = Self;
40    type CanonicalVTable = Self;
41    type OperationsVTable = Self;
42    type ValidityVTable = Self;
43    type VisitorVTable = Self;
44    // TODO(ngates): implement a compute kernel for elementwise operations
45    type ComputeVTable = NotSupported;
46    type EncodeVTable = Self;
47    type SerdeVTable = Self;
48
49    fn id(_encoding: &Self::Encoding) -> EncodingId {
50        EncodingId::new_ref("vortex.constant")
51    }
52
53    fn encoding(_array: &Self::Array) -> EncodingRef {
54        EncodingRef::new_ref(ConstantEncoding.as_ref())
55    }
56}
57
58impl ConstantArray {
59    pub fn new<S>(scalar: S, len: usize) -> Self
60    where
61        S: Into<Scalar>,
62    {
63        let scalar = scalar.into();
64        Self {
65            scalar,
66            len,
67            stats_set: Default::default(),
68        }
69    }
70
71    /// Returns the [`Scalar`] value of this constant array.
72    pub fn scalar(&self) -> &Scalar {
73        &self.scalar
74    }
75}
76
77impl ArrayVTable<ConstantVTable> for ConstantVTable {
78    fn len(array: &ConstantArray) -> usize {
79        array.len
80    }
81
82    fn dtype(array: &ConstantArray) -> &DType {
83        array.scalar.dtype()
84    }
85
86    fn stats(array: &ConstantArray) -> StatsSetRef<'_> {
87        array.stats_set.to_ref(array.as_ref())
88    }
89}
90
91impl OperationsVTable<ConstantVTable> for ConstantVTable {
92    fn slice(array: &ConstantArray, start: usize, stop: usize) -> VortexResult<ArrayRef> {
93        Ok(ConstantArray::new(array.scalar.clone(), stop - start).into_array())
94    }
95
96    fn scalar_at(array: &ConstantArray, _index: usize) -> VortexResult<Scalar> {
97        Ok(array.scalar.clone())
98    }
99}
100
101impl ValidityVTable<ConstantVTable> for ConstantVTable {
102    fn is_valid(array: &ConstantArray, _index: usize) -> VortexResult<bool> {
103        Ok(!array.scalar().is_null())
104    }
105
106    fn all_valid(array: &ConstantArray) -> VortexResult<bool> {
107        Ok(!array.scalar().is_null())
108    }
109
110    fn all_invalid(array: &ConstantArray) -> VortexResult<bool> {
111        Ok(array.scalar().is_null())
112    }
113
114    fn validity_mask(array: &ConstantArray) -> VortexResult<Mask> {
115        Ok(match array.scalar().is_null() {
116            true => Mask::AllFalse(array.len()),
117            false => Mask::AllTrue(array.len()),
118        })
119    }
120}
121
122impl VisitorVTable<ConstantVTable> for ConstantVTable {
123    fn visit_buffers(array: &ConstantArray, visitor: &mut dyn ArrayBufferVisitor) {
124        let buffer = array
125            .scalar
126            .value()
127            .to_protobytes::<ByteBufferMut>()
128            .freeze();
129        visitor.visit_buffer(&buffer);
130    }
131
132    fn visit_children(_array: &ConstantArray, _visitor: &mut dyn ArrayChildVisitor) {}
133}
vortex_array/arrays/constant/mod.rs

vortex_array/arrays/constant/
mod.rs
