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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
use crate::{
bitmap::{
utils::{zip_validity, BitmapIter, ZipValidity},
Bitmap, MutableBitmap,
},
datatypes::{DataType, PhysicalType},
error::Error,
trusted_len::TrustedLen,
};
use either::Either;
use super::Array;
mod ffi;
pub(super) mod fmt;
mod from;
mod iterator;
mod mutable;
pub use iterator::*;
pub use mutable::*;
#[derive(Clone)]
pub struct BooleanArray {
data_type: DataType,
values: Bitmap,
validity: Option<Bitmap>,
}
impl BooleanArray {
pub fn try_new(
data_type: DataType,
values: Bitmap,
validity: Option<Bitmap>,
) -> Result<Self, Error> {
if validity
.as_ref()
.map_or(false, |validity| validity.len() != values.len())
{
return Err(Error::oos(
"validity mask length must match the number of values",
));
}
if data_type.to_physical_type() != PhysicalType::Boolean {
return Err(Error::oos(
"BooleanArray can only be initialized with a DataType whose physical type is Boolean",
));
}
Ok(Self {
data_type,
values,
validity,
})
}
#[inline]
pub fn iter(&self) -> ZipValidity<bool, BitmapIter> {
zip_validity(
self.values().iter(),
self.validity.as_ref().map(|x| x.iter()),
)
}
#[inline]
pub fn values_iter(&self) -> BitmapIter {
self.values().iter()
}
#[inline]
pub fn len(&self) -> usize {
self.values.len()
}
#[inline]
pub fn values(&self) -> &Bitmap {
&self.values
}
#[inline]
pub fn validity(&self) -> Option<&Bitmap> {
self.validity.as_ref()
}
#[inline]
pub fn data_type(&self) -> &DataType {
&self.data_type
}
#[inline]
pub fn value(&self, i: usize) -> bool {
self.values.get_bit(i)
}
#[inline]
pub unsafe fn value_unchecked(&self, i: usize) -> bool {
self.values.get_bit_unchecked(i)
}
#[inline]
#[must_use]
pub fn slice(&self, offset: usize, length: usize) -> Self {
assert!(
offset + length <= self.len(),
"the offset of the new Buffer cannot exceed the existing length"
);
unsafe { self.slice_unchecked(offset, length) }
}
#[inline]
#[must_use]
pub unsafe fn slice_unchecked(&self, offset: usize, length: usize) -> Self {
let validity = self
.validity
.clone()
.map(|x| x.slice_unchecked(offset, length));
Self {
data_type: self.data_type.clone(),
values: self.values.clone().slice_unchecked(offset, length),
validity,
}
}
#[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>) {
if matches!(&validity, Some(bitmap) if bitmap.len() != self.len()) {
panic!("validity must be equal to the array's length")
}
self.validity = validity;
}
#[must_use]
pub fn with_values(&self, values: Bitmap) -> Self {
let mut out = self.clone();
out.set_values(values);
out
}
pub fn set_values(&mut self, values: Bitmap) {
assert_eq!(
values.len(),
self.len(),
"values length must be equal to this arrays length"
);
self.values = values;
}
pub fn apply_values_mut<F: Fn(&mut MutableBitmap)>(&mut self, f: F) {
let values = std::mem::take(&mut self.values);
let mut values = values.make_mut();
f(&mut values);
if let Some(validity) = &self.validity {
assert_eq!(validity.len(), values.len());
}
self.values = values.into();
}
pub fn into_mut(self) -> Either<Self, MutableBooleanArray> {
use Either::*;
if let Some(bitmap) = self.validity {
match bitmap.into_mut() {
Left(bitmap) => Left(BooleanArray::new(self.data_type, self.values, Some(bitmap))),
Right(mutable_bitmap) => match self.values.into_mut() {
Left(immutable) => Left(BooleanArray::new(
self.data_type,
immutable,
Some(mutable_bitmap.into()),
)),
Right(mutable) => Right(MutableBooleanArray::from_data(
self.data_type,
mutable,
Some(mutable_bitmap),
)),
},
}
} else {
match self.values.into_mut() {
Left(immutable) => Left(BooleanArray::new(self.data_type, immutable, None)),
Right(mutable) => Right(MutableBooleanArray::from_data(
self.data_type,
mutable,
None,
)),
}
}
}
pub fn new_empty(data_type: DataType) -> Self {
Self::new(data_type, Bitmap::new(), None)
}
pub fn new_null(data_type: DataType, length: usize) -> Self {
let bitmap = Bitmap::new_zeroed(length);
Self::new(data_type, bitmap.clone(), Some(bitmap))
}
#[inline]
pub fn from_trusted_len_values_iter<I: TrustedLen<Item = bool>>(iterator: I) -> Self {
MutableBooleanArray::from_trusted_len_values_iter(iterator).into()
}
#[inline]
pub unsafe fn from_trusted_len_values_iter_unchecked<I: Iterator<Item = bool>>(
iterator: I,
) -> Self {
MutableBooleanArray::from_trusted_len_values_iter_unchecked(iterator).into()
}
#[inline]
pub fn from_slice<P: AsRef<[bool]>>(slice: P) -> Self {
MutableBooleanArray::from_slice(slice).into()
}
#[inline]
pub unsafe fn from_trusted_len_iter_unchecked<I, P>(iterator: I) -> Self
where
P: std::borrow::Borrow<bool>,
I: Iterator<Item = Option<P>>,
{
MutableBooleanArray::from_trusted_len_iter_unchecked(iterator).into()
}
#[inline]
pub fn from_trusted_len_iter<I, P>(iterator: I) -> Self
where
P: std::borrow::Borrow<bool>,
I: TrustedLen<Item = Option<P>>,
{
MutableBooleanArray::from_trusted_len_iter(iterator).into()
}
#[inline]
pub unsafe fn try_from_trusted_len_iter_unchecked<E, I, P>(iterator: I) -> Result<Self, E>
where
P: std::borrow::Borrow<bool>,
I: Iterator<Item = Result<Option<P>, E>>,
{
Ok(MutableBooleanArray::try_from_trusted_len_iter_unchecked(iterator)?.into())
}
#[inline]
pub fn try_from_trusted_len_iter<E, I, P>(iterator: I) -> Result<Self, E>
where
P: std::borrow::Borrow<bool>,
I: TrustedLen<Item = Result<Option<P>, E>>,
{
Ok(MutableBooleanArray::try_from_trusted_len_iter(iterator)?.into())
}
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 fn new(data_type: DataType, values: Bitmap, validity: Option<Bitmap>) -> Self {
Self::try_new(data_type, values, validity).unwrap()
}
pub fn from_data(data_type: DataType, values: Bitmap, validity: Option<Bitmap>) -> Self {
Self::new(data_type, values, validity)
}
}
impl Array for BooleanArray {
#[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
}
#[inline]
fn validity(&self) -> Option<&Bitmap> {
self.validity.as_ref()
}
#[inline]
fn slice(&self, offset: usize, length: usize) -> Box<dyn Array> {
Box::new(self.slice(offset, length))
}
#[inline]
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())
}
}