This repository has been archived by the owner on Feb 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 221
/
mod.rs
225 lines (203 loc) · 6.7 KB
/
mod.rs
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
use std::sync::Arc;
use crate::{
bitmap::Bitmap,
datatypes::{DataType, Field},
};
use super::{new_empty_array, new_null_array, Array};
mod ffi;
mod iterator;
/// A [`StructArray`] is a nested [`Array`] with an optional validity representing
/// multiple [`Array`] with the same number of rows.
/// # Example
/// ```
/// use std::sync::Arc;
/// use arrow2::array::*;
/// use arrow2::datatypes::*;
/// let boolean = Arc::new(BooleanArray::from_slice(&[false, false, true, true])) as Arc<dyn Array>;
/// let int = Arc::new(Int32Array::from_slice(&[42, 28, 19, 31])) as Arc<dyn Array>;
///
/// let fields = vec![
/// Field::new("b", DataType::Boolean, false),
/// Field::new("c", DataType::Int32, false),
/// ];
///
/// let array = StructArray::from_data(DataType::Struct(fields), vec![boolean, int], None);
/// ```
#[derive(Debug, Clone)]
pub struct StructArray {
data_type: DataType,
values: Vec<Arc<dyn Array>>,
validity: Option<Bitmap>,
}
impl StructArray {
/// Creates an empty [`StructArray`].
pub fn new_empty(data_type: DataType) -> Self {
if let DataType::Struct(fields) = &data_type {
let values = fields
.iter()
.map(|field| new_empty_array(field.data_type().clone()).into())
.collect();
Self::from_data(data_type, values, None)
} else {
panic!("StructArray must be initialized with DataType::Struct");
}
}
/// Creates a null [`StructArray`] of length `length`.
pub fn new_null(data_type: DataType, length: usize) -> Self {
if let DataType::Struct(fields) = &data_type {
let values = fields
.iter()
.map(|field| new_null_array(field.data_type().clone(), length).into())
.collect();
Self::from_data(data_type, values, Some(Bitmap::new_zeroed(length)))
} else {
panic!("StructArray must be initialized with DataType::Struct");
}
}
/// Canonical method to create a [`StructArray`].
/// # Panics
/// * fields are empty
/// * values's len is different from Fields' length.
/// * any element of values has a different length than the first element.
pub fn from_data(
data_type: DataType,
values: Vec<Arc<dyn Array>>,
validity: Option<Bitmap>,
) -> Self {
let fields = Self::get_fields(&data_type);
assert!(!fields.is_empty());
assert_eq!(fields.len(), values.len());
assert!(values.iter().all(|x| x.len() == values[0].len()));
if let Some(ref validity) = validity {
assert_eq!(values[0].len(), validity.len());
}
Self {
data_type,
values,
validity,
}
}
/// Deconstructs the [`StructArray`] into its individual components.
pub fn into_data(self) -> (Vec<Field>, Vec<Arc<dyn Array>>, Option<Bitmap>) {
let Self {
data_type,
values,
validity,
} = self;
let fields = if let DataType::Struct(fields) = data_type {
fields
} else {
unreachable!()
};
(fields, values, validity)
}
/// Creates a new [`StructArray`] that is a slice of `self`.
/// # Panics
/// * `offset + length` must be smaller than `self.len()`.
/// # Implementation
/// This operation is `O(F)` where `F` is the number of fields.
pub fn slice(&self, offset: usize, length: usize) -> Self {
assert!(
offset + length <= self.len(),
"offset + length may not exceed length of array"
);
unsafe { self.slice_unchecked(offset, length) }
}
/// Creates a new [`StructArray`] that is a slice of `self`.
/// # Implementation
/// This operation is `O(F)` where `F` is the number of fields.
/// # Safety
/// The caller must ensure that `offset + length <= self.len()`.
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
.iter()
.map(|x| x.slice_unchecked(offset, length).into())
.collect(),
validity,
}
}
/// Sets the validity bitmap on this [`StructArray`].
/// # Panic
/// This function panics iff `validity.len() != self.len()`.
pub fn with_validity(&self, validity: Option<Bitmap>) -> Self {
if matches!(&validity, Some(bitmap) if bitmap.len() != self.len()) {
panic!("validity should be as least as large as the array")
}
let mut arr = self.clone();
arr.validity = validity;
arr
}
}
// Accessors
impl StructArray {
#[inline]
fn len(&self) -> usize {
self.values[0].len()
}
/// The optional validity.
#[inline]
pub fn validity(&self) -> Option<&Bitmap> {
self.validity.as_ref()
}
/// Returns the values of this [`StructArray`].
pub fn values(&self) -> &[Arc<dyn Array>] {
&self.values
}
/// Returns the fields of this [`StructArray`].
pub fn fields(&self) -> &[Field] {
Self::get_fields(&self.data_type)
}
}
impl StructArray {
/// Returns the fields the `DataType::Struct`.
pub fn get_fields(data_type: &DataType) -> &[Field] {
match data_type {
DataType::Struct(fields) => fields,
DataType::Extension(_, inner, _) => Self::get_fields(inner),
_ => panic!("Wrong datatype passed to Struct."),
}
}
}
impl Array for StructArray {
#[inline]
fn as_any(&self) -> &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()
}
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.with_validity(validity))
}
}
impl std::fmt::Display for StructArray {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
writeln!(f, "StructArray{{")?;
for (field, column) in self.fields().iter().zip(self.values()) {
writeln!(f, "{}: {},", field.name(), column)?;
}
write!(f, "}}")
}
}