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
use std::sync::Arc;
use crate::{
bitmap::Bitmap,
datatypes::{DataType, Field},
error::Error,
};
use super::{new_empty_array, new_null_array, Array};
#[cfg(feature = "arrow")]
mod data;
mod ffi;
pub(super) mod fmt;
mod iterator;
mod mutable;
pub use mutable::*;
/// A [`StructArray`] is a nested [`Array`] with an optional validity representing
/// multiple [`Array`] with the same number of rows.
/// # Example
/// ```
/// use re_arrow2::array::*;
/// use re_arrow2::datatypes::*;
/// let boolean = BooleanArray::from_slice(&[false, false, true, true]).boxed();
/// let int = Int32Array::from_slice(&[42, 28, 19, 31]).boxed();
///
/// let fields = vec![
/// Field::new("b", DataType::Boolean, false),
/// Field::new("c", DataType::Int32, false),
/// ];
///
/// let array = StructArray::new(DataType::Struct(std::sync::Arc::new(fields)), vec![boolean, int], None);
/// ```
#[derive(Clone)]
pub struct StructArray {
data_type: DataType,
values: Vec<Box<dyn Array>>,
validity: Option<Bitmap>,
}
impl StructArray {
/// Returns a new [`StructArray`].
/// # Errors
/// This function errors iff:
/// * `data_type`'s physical type is not [`crate::datatypes::PhysicalType::Struct`].
/// * the children of `data_type` are empty
/// * the values's len is different from children's length
/// * any of the values's data type is different from its corresponding children' data type
/// * any element of values has a different length than the first element
/// * the validity's length is not equal to the length of the first element
pub fn try_new(
data_type: DataType,
values: Vec<Box<dyn Array>>,
validity: Option<Bitmap>,
) -> Result<Self, Error> {
let fields = Self::try_get_fields(&data_type)?;
if fields.is_empty() {
return Err(Error::oos("A StructArray must contain at least one field"));
}
if fields.len() != values.len() {
return Err(Error::oos(
"A StructArray must have a number of fields in its DataType equal to the number of child values",
));
}
fields
.iter().map(|a| &a.data_type)
.zip(values.iter().map(|a| a.data_type()))
.enumerate()
.try_for_each(|(index, (data_type, child))| {
if data_type != child {
Err(Error::oos(format!(
"The children DataTypes of a StructArray must equal the children data types.
However, the field {index} has data type {data_type:?} but the value has data type {child:?}"
)))
} else {
Ok(())
}
})?;
let len = values[0].len();
values
.iter()
.map(|a| a.len())
.enumerate()
.try_for_each(|(index, a_len)| {
if a_len != len {
Err(Error::oos(format!(
"The children must have an equal number of values.
However, the values at index {index} have a length of {a_len}, which is different from values at index 0, {len}."
)))
} else {
Ok(())
}
})?;
if validity
.as_ref()
.map_or(false, |validity| validity.len() != len)
{
return Err(Error::oos(
"The validity length of a StructArray must match its number of elements",
));
}
Ok(Self {
data_type,
values,
validity,
})
}
/// Returns a new [`StructArray`]
/// # Panics
/// This function panics iff:
/// * `data_type`'s physical type is not [`crate::datatypes::PhysicalType::Struct`].
/// * the children of `data_type` are empty
/// * the values's len is different from children's length
/// * any of the values's data type is different from its corresponding children' data type
/// * any element of values has a different length than the first element
/// * the validity's length is not equal to the length of the first element
pub fn new(data_type: DataType, values: Vec<Box<dyn Array>>, validity: Option<Bitmap>) -> Self {
Self::try_new(data_type, values, validity).unwrap()
}
/// Creates an empty [`StructArray`].
pub fn new_empty(data_type: DataType) -> Self {
if let DataType::Struct(fields) = &data_type.to_logical_type() {
let values = fields
.iter()
.map(|field| new_empty_array(field.data_type().clone()))
.collect();
Self::new(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))
.collect();
Self::new(data_type, values, Some(Bitmap::new_zeroed(length)))
} else {
panic!("StructArray must be initialized with DataType::Struct");
}
}
}
// must use
impl StructArray {
/// Deconstructs the [`StructArray`] into its individual components.
#[must_use]
pub fn into_data(self) -> (Arc<Vec<Field>>, Vec<Box<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)
}
/// Slices this [`StructArray`].
/// # 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(&mut self, offset: usize, length: usize) {
assert!(
offset + length <= self.len(),
"offset + length may not exceed length of array"
);
unsafe { self.slice_unchecked(offset, length) }
}
/// Slices this [`StructArray`].
/// # 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(&mut self, offset: usize, length: usize) {
self.validity.as_mut().and_then(|bitmap| {
bitmap.slice_unchecked(offset, length);
(bitmap.unset_bits() > 0).then(|| bitmap)
});
self.values
.iter_mut()
.for_each(|x| x.slice_unchecked(offset, length));
}
impl_sliced!();
impl_mut_validity!();
impl_into_array!();
}
// 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) -> &[Box<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(crate) fn try_get_fields(data_type: &DataType) -> Result<&[Field], Error> {
match data_type.to_logical_type() {
DataType::Struct(fields) => Ok(fields),
_ => Err(Error::oos(
"Struct array must be created with a DataType whose physical type is Struct",
)),
}
}
/// Returns the fields the `DataType::Struct`.
pub fn get_fields(data_type: &DataType) -> &[Field] {
Self::try_get_fields(data_type).unwrap()
}
}
impl Array for StructArray {
impl_common_array!();
fn validity(&self) -> Option<&Bitmap> {
self.validity.as_ref()
}
#[inline]
fn with_validity(&self, validity: Option<Bitmap>) -> Box<dyn Array> {
Box::new(self.clone().with_validity(validity))
}
}