1use vortex_array::arrays::ConstantArray;
5use vortex_array::compute::{TakeKernel, TakeKernelAdapter};
6use vortex_array::{Array, ArrayRef, IntoArray, register_kernel};
7use vortex_error::VortexResult;
8
9use crate::{SparseArray, SparseVTable};
10
11impl TakeKernel for SparseVTable {
12 fn take(&self, array: &SparseArray, take_indices: &dyn Array) -> VortexResult<ArrayRef> {
13 let patches_take = if array.fill_scalar().is_null() {
14 array.patches().take(take_indices)?
15 } else {
16 array.patches().take_with_nulls(take_indices)?
17 };
18
19 let Some(new_patches) = patches_take else {
20 let result_fill_scalar = array.fill_scalar().cast(
21 &array
22 .dtype()
23 .union_nullability(take_indices.dtype().nullability()),
24 )?;
25 return Ok(ConstantArray::new(result_fill_scalar, take_indices.len()).into_array());
26 };
27
28 if new_patches.array_len() == new_patches.values().len() {
30 return Ok(new_patches.into_values());
31 }
32
33 Ok(SparseArray::try_new_from_patches(
34 new_patches,
35 array.fill_scalar().cast(
36 &array
37 .dtype()
38 .union_nullability(take_indices.dtype().nullability()),
39 )?,
40 )?
41 .into_array())
42 }
43}
44
45register_kernel!(TakeKernelAdapter(SparseVTable).lift());
46
47#[cfg(test)]
48mod test {
49 use rstest::rstest;
50 use vortex_array::arrays::PrimitiveArray;
51 use vortex_array::compute::take;
52 use vortex_array::validity::Validity;
53 use vortex_array::{Array, ArrayRef, IntoArray, ToCanonical};
54 use vortex_buffer::buffer;
55 use vortex_dtype::PType::I32;
56 use vortex_dtype::{DType, Nullability};
57 use vortex_scalar::Scalar;
58
59 use crate::{SparseArray, SparseVTable};
60
61 fn test_array_fill_value() -> Scalar {
62 Scalar::null_typed::<f64>()
64 }
65
66 fn sparse_array() -> ArrayRef {
67 SparseArray::try_new(
68 buffer![0u64, 37, 47, 99].into_array(),
69 PrimitiveArray::new(buffer![1.23f64, 0.47, 9.99, 3.5], Validity::AllValid).into_array(),
70 100,
71 test_array_fill_value(),
72 )
73 .unwrap()
74 .into_array()
75 }
76
77 #[test]
78 fn take_with_non_zero_offset() {
79 let sparse = sparse_array();
80 let sparse = sparse.slice(30..40);
81 let sparse = take(&sparse, &buffer![6, 7, 8].into_array()).unwrap();
82 assert_eq!(sparse.scalar_at(0), test_array_fill_value());
83 assert_eq!(sparse.scalar_at(1), Scalar::from(Some(0.47)));
84 assert_eq!(sparse.scalar_at(2), test_array_fill_value());
85 }
86
87 #[test]
88 fn sparse_take() {
89 let sparse = sparse_array();
90 let prim = take(&sparse, &buffer![0, 47, 47, 0, 99].into_array())
91 .unwrap()
92 .to_primitive();
93 assert_eq!(prim.as_slice::<f64>(), [1.23f64, 9.99, 9.99, 1.23, 3.5]);
94 }
95
96 #[test]
97 fn nonexistent_take() {
98 let sparse = sparse_array();
99 let taken = take(&sparse, &buffer![69].into_array()).unwrap();
100 assert_eq!(taken.len(), 1);
101 assert_eq!(taken.scalar_at(0), test_array_fill_value());
102 }
103
104 #[test]
105 fn ordered_take() {
106 let sparse = sparse_array();
107 let taken_arr = take(&sparse, &buffer![69, 37].into_array()).unwrap();
108 let taken = taken_arr.as_::<SparseVTable>();
109
110 assert_eq!(
111 taken.patches().indices().to_primitive().as_slice::<u64>(),
112 [1]
113 );
114 assert_eq!(
115 taken.patches().values().to_primitive().as_slice::<f64>(),
116 [0.47f64]
117 );
118 assert_eq!(taken.len(), 2);
119 }
120
121 #[test]
122 fn nullable_take() {
123 let arr = SparseArray::try_new(
124 buffer![1u32].into_array(),
125 buffer![10].into_array(),
126 10,
127 Scalar::primitive(1, Nullability::NonNullable),
128 )
129 .unwrap();
130
131 let taken = take(
132 arr.as_ref(),
133 PrimitiveArray::from_option_iter([Some(2u32), Some(1u32), Option::<u32>::None])
134 .as_ref(),
135 )
136 .unwrap();
137
138 assert_eq!(
139 taken.scalar_at(0),
140 Scalar::primitive(1, Nullability::Nullable)
141 );
142 assert_eq!(
143 taken.scalar_at(1),
144 Scalar::primitive(10, Nullability::Nullable)
145 );
146 assert_eq!(
147 taken.scalar_at(2),
148 Scalar::null(DType::Primitive(I32, Nullability::Nullable))
149 );
150 }
151
152 #[test]
153 fn nullable_take_with_many_patches() {
154 let arr = SparseArray::try_new(
155 buffer![1u32, 3, 7, 8, 9].into_array(),
156 buffer![10, 8, 3, 2, 1].into_array(),
157 10,
158 Scalar::primitive(1, Nullability::NonNullable),
159 )
160 .unwrap();
161
162 let taken = take(
163 arr.as_ref(),
164 PrimitiveArray::from_option_iter([Some(2u32), Some(1u32), Option::<u32>::None])
165 .as_ref(),
166 )
167 .unwrap();
168
169 assert_eq!(
170 taken.scalar_at(0),
171 Scalar::primitive(1, Nullability::Nullable)
172 );
173 assert_eq!(
174 taken.scalar_at(1),
175 Scalar::primitive(10, Nullability::Nullable)
176 );
177 assert_eq!(
178 taken.scalar_at(2),
179 Scalar::null(DType::Primitive(I32, Nullability::Nullable))
180 );
181 }
182
183 #[rstest]
184 #[case(SparseArray::try_new(
185 buffer![0u64, 37, 47, 99].into_array(),
186 PrimitiveArray::new(buffer![1.23f64, 0.47, 9.99, 3.5], Validity::AllValid).into_array(),
187 100,
188 Scalar::null_typed::<f64>(),
189 ).unwrap())]
190 #[case(SparseArray::try_new(
191 buffer![1u32, 3, 7, 8, 9].into_array(),
192 buffer![10, 8, 3, 2, 1].into_array(),
193 10,
194 Scalar::from(0i32),
195 ).unwrap())]
196 #[case({
197 let nullable_values = PrimitiveArray::from_option_iter([Some(100i64), None, Some(300)]);
198 SparseArray::try_new(
199 buffer![2u64, 4, 6].into_array(),
200 nullable_values.into_array(),
201 10,
202 Scalar::null_typed::<i64>(),
203 ).unwrap()
204 })]
205 #[case(SparseArray::try_new(
206 buffer![5u64].into_array(),
207 buffer![999i32].into_array(),
208 20,
209 Scalar::from(-1i32),
210 ).unwrap())]
211 fn test_take_sparse_conformance(#[case] sparse: SparseArray) {
212 use vortex_array::compute::conformance::take::test_take_conformance;
213 test_take_conformance(sparse.as_ref());
214 }
215}