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
use std::hint::unreachable_unchecked;
use crate::{
bitmap::{
utils::{zip_validity, ZipValidity},
Bitmap,
},
datatypes::{DataType, IntegerType},
error::Error,
scalar::{new_scalar, Scalar},
trusted_len::TrustedLen,
types::NativeType,
};
mod ffi;
pub(super) mod fmt;
mod iterator;
mod mutable;
pub use iterator::*;
pub use mutable::*;
use super::{new_empty_array, primitive::PrimitiveArray, Array};
use super::{new_null_array, specification::check_indexes};
pub trait DictionaryKey: NativeType + TryInto<usize> + TryFrom<usize> {
const KEY_TYPE: IntegerType;
#[inline]
unsafe fn as_usize(self) -> usize {
match self.try_into() {
Ok(v) => v,
Err(_) => unreachable_unchecked(),
}
}
}
impl DictionaryKey for i8 {
const KEY_TYPE: IntegerType = IntegerType::Int8;
}
impl DictionaryKey for i16 {
const KEY_TYPE: IntegerType = IntegerType::Int16;
}
impl DictionaryKey for i32 {
const KEY_TYPE: IntegerType = IntegerType::Int32;
}
impl DictionaryKey for i64 {
const KEY_TYPE: IntegerType = IntegerType::Int64;
}
impl DictionaryKey for u8 {
const KEY_TYPE: IntegerType = IntegerType::UInt8;
}
impl DictionaryKey for u16 {
const KEY_TYPE: IntegerType = IntegerType::UInt16;
}
impl DictionaryKey for u32 {
const KEY_TYPE: IntegerType = IntegerType::UInt32;
}
impl DictionaryKey for u64 {
const KEY_TYPE: IntegerType = IntegerType::UInt64;
}
#[derive(Clone)]
pub struct DictionaryArray<K: DictionaryKey> {
data_type: DataType,
keys: PrimitiveArray<K>,
values: Box<dyn Array>,
}
fn check_data_type(
key_type: IntegerType,
data_type: &DataType,
values_data_type: &DataType,
) -> Result<(), Error> {
if let DataType::Dictionary(key, value, _) = data_type.to_logical_type() {
if *key != key_type {
return Err(Error::oos(
"DictionaryArray must be initialized with a DataType::Dictionary whose integer is compatible to its keys",
));
}
if value.as_ref().to_logical_type() != values_data_type.to_logical_type() {
return Err(Error::oos(
"DictionaryArray must be initialized with a DataType::Dictionary whose value is equal to its values",
));
}
} else {
return Err(Error::oos(
"DictionaryArray must be initialized with logical DataType::Dictionary",
));
}
Ok(())
}
impl<K: DictionaryKey> DictionaryArray<K> {
pub fn try_new(
data_type: DataType,
keys: PrimitiveArray<K>,
values: Box<dyn Array>,
) -> Result<Self, Error> {
check_data_type(K::KEY_TYPE, &data_type, values.data_type())?;
check_indexes(keys.values(), values.len())?;
Ok(Self {
data_type,
keys,
values,
})
}
pub fn try_from_keys(keys: PrimitiveArray<K>, values: Box<dyn Array>) -> Result<Self, Error> {
let data_type = Self::default_data_type(values.data_type().clone());
Self::try_new(data_type, keys, values)
}
pub unsafe fn try_new_unchecked(
data_type: DataType,
keys: PrimitiveArray<K>,
values: Box<dyn Array>,
) -> Result<Self, Error> {
check_data_type(K::KEY_TYPE, &data_type, values.data_type())?;
Ok(Self {
data_type,
keys,
values,
})
}
pub fn new_empty(data_type: DataType) -> Self {
let values = Self::try_get_child(&data_type).unwrap();
let values = new_empty_array(values.clone());
Self::try_new(
data_type,
PrimitiveArray::<K>::new_empty(K::PRIMITIVE.into()),
values,
)
.unwrap()
}
#[inline]
pub fn new_null(data_type: DataType, length: usize) -> Self {
let values = Self::try_get_child(&data_type).unwrap();
let values = new_null_array(values.clone(), 1);
Self::try_new(
data_type,
PrimitiveArray::<K>::new_null(K::PRIMITIVE.into(), length),
values,
)
.unwrap()
}
pub fn iter(&self) -> ZipValidity<Box<dyn Scalar>, DictionaryValuesIter<K>> {
zip_validity(
DictionaryValuesIter::new(self),
self.keys.validity().as_ref().map(|x| x.iter()),
)
}
pub fn values_iter(&self) -> DictionaryValuesIter<K> {
DictionaryValuesIter::new(self)
}
#[inline]
pub fn data_type(&self) -> &DataType {
&self.data_type
}
#[inline]
pub fn is_ordered(&self) -> bool {
match self.data_type.to_logical_type() {
DataType::Dictionary(_, _, is_ordered) => *is_ordered,
_ => unreachable!(),
}
}
pub(crate) fn default_data_type(values_datatype: DataType) -> DataType {
DataType::Dictionary(K::KEY_TYPE, Box::new(values_datatype), false)
}
pub fn slice(&self, offset: usize, length: usize) -> Self {
Self {
data_type: self.data_type.clone(),
keys: self.keys.clone().slice(offset, length),
values: self.values.clone(),
}
}
pub unsafe fn slice_unchecked(&self, offset: usize, length: usize) -> Self {
Self {
data_type: self.data_type.clone(),
keys: self.keys.clone().slice_unchecked(offset, length),
values: self.values.clone(),
}
}
#[must_use]
pub fn with_validity(mut self, validity: Option<Bitmap>) -> Self {
self.set_validity(validity);
self
}
pub fn set_validity(&mut self, validity: Option<Bitmap>) {
self.keys.set_validity(validity);
}
#[inline]
pub fn len(&self) -> usize {
self.keys.len()
}
#[inline]
pub fn validity(&self) -> Option<&Bitmap> {
self.keys.validity()
}
#[inline]
pub fn keys(&self) -> &PrimitiveArray<K> {
&self.keys
}
#[inline]
pub fn keys_values_iter(&self) -> impl TrustedLen<Item = usize> + Clone + '_ {
self.keys.values_iter().map(|x| unsafe { x.as_usize() })
}
#[inline]
pub fn keys_iter(&self) -> impl TrustedLen<Item = Option<usize>> + Clone + '_ {
self.keys.iter().map(|x| x.map(|x| unsafe { x.as_usize() }))
}
#[inline]
pub fn key_value(&self, index: usize) -> usize {
unsafe { self.keys.values()[index].as_usize() }
}
#[inline]
pub fn values(&self) -> &Box<dyn Array> {
&self.values
}
#[inline]
pub fn value(&self, index: usize) -> Box<dyn Scalar> {
let index = unsafe { self.keys.value(index).as_usize() };
new_scalar(self.values.as_ref(), index)
}
pub fn boxed(self) -> Box<dyn Array> {
Box::new(self)
}
pub fn arced(self) -> std::sync::Arc<dyn Array> {
std::sync::Arc::new(self)
}
pub(crate) fn try_get_child(data_type: &DataType) -> Result<&DataType, Error> {
Ok(match data_type.to_logical_type() {
DataType::Dictionary(_, values, _) => values.as_ref(),
_ => {
return Err(Error::oos(
"Dictionaries must be initialized with DataType::Dictionary",
))
}
})
}
}
impl<K: DictionaryKey> Array for DictionaryArray<K> {
#[inline]
fn as_any(&self) -> &dyn std::any::Any {
self
}
#[inline]
fn as_any_mut(&mut self) -> &mut dyn std::any::Any {
self
}
#[inline]
fn len(&self) -> usize {
self.len()
}
#[inline]
fn data_type(&self) -> &DataType {
&self.data_type
}
fn validity(&self) -> Option<&Bitmap> {
self.keys.validity()
}
fn slice(&self, offset: usize, length: usize) -> Box<dyn Array> {
Box::new(self.slice(offset, length))
}
unsafe fn slice_unchecked(&self, offset: usize, length: usize) -> Box<dyn Array> {
Box::new(self.slice_unchecked(offset, length))
}
fn with_validity(&self, validity: Option<Bitmap>) -> Box<dyn Array> {
Box::new(self.clone().with_validity(validity))
}
fn to_boxed(&self) -> Box<dyn Array> {
Box::new(self.clone())
}
}