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
use std::marker::PhantomData;
use std::pin::Pin;
use std::ptr::NonNull;
use crate::prelude::*;
use crate::series::unstable::{ArrayBox, UnstableSeries};
use crate::utils::CustomIterTools;
pub struct AmortizedListIter<'a, I: Iterator<Item = Option<ArrayBox>>> {
len: usize,
series_container: Pin<Box<Series>>,
inner: NonNull<ArrayRef>,
lifetime: PhantomData<&'a ArrayRef>,
iter: I,
// used only if feature="dtype-struct"
#[allow(dead_code)]
inner_dtype: DataType,
}
impl<'a, I: Iterator<Item = Option<ArrayBox>>> AmortizedListIter<'a, I> {
pub(crate) fn new(
len: usize,
series_container: Pin<Box<Series>>,
inner: NonNull<ArrayRef>,
iter: I,
inner_dtype: DataType,
) -> Self {
Self {
len,
series_container,
inner,
lifetime: PhantomData,
iter,
inner_dtype,
}
}
}
impl<'a, I: Iterator<Item = Option<ArrayBox>>> Iterator for AmortizedListIter<'a, I> {
type Item = Option<UnstableSeries<'a>>;
fn next(&mut self) -> Option<Self::Item> {
self.iter.next().map(|opt_val| {
opt_val.map(|array_ref| {
#[cfg(feature = "dtype-struct")]
// structs arrays are bound to the series not to the arrayref
// so we must get a hold to the new array
if matches!(self.inner_dtype, DataType::Struct(_)) {
// Safety
// dtype is known
unsafe {
let mut s = Series::from_chunks_and_dtype_unchecked(
"",
vec![array_ref],
&self.inner_dtype.to_physical(),
)
.cast_unchecked(&self.inner_dtype)
.unwrap();
// swap the new series with the container
std::mem::swap(&mut *self.series_container, &mut s);
// return a reference to the container
// this lifetime is now bound to 'a
return UnstableSeries::new(
&mut *(&mut *self.series_container as *mut Series),
);
}
}
// update the inner state
unsafe { *self.inner.as_mut() = array_ref };
// last iteration could have set the sorted flag (e.g. in compute_len)
self.series_container.clear_settings();
// make sure that the length is correct
self.series_container._get_inner_mut().compute_len();
// Safety
// we cannot control the lifetime of an iterators `next` method.
// but as long as self is alive the reference to the series container is valid
let refer = &mut *self.series_container;
unsafe {
let s = std::mem::transmute::<&mut Series, &'a mut Series>(refer);
UnstableSeries::new_with_chunk(s, self.inner.as_ref())
}
})
})
}
fn size_hint(&self) -> (usize, Option<usize>) {
(self.len, Some(self.len))
}
}
// # Safety
// we correctly implemented size_hint
unsafe impl<'a, I: Iterator<Item = Option<ArrayBox>>> TrustedLen for AmortizedListIter<'a, I> {}
impl ListChunked {
/// This is an iterator over a [`ListChunked`] that save allocations.
/// A Series is:
/// 1. [`Arc<ChunkedArray>`]
/// ChunkedArray is:
/// 2. Vec< 3. ArrayRef>
///
/// The ArrayRef we indicated with 3. will be updated during iteration.
/// The Series will be pinned in memory, saving an allocation for
/// 1. Arc<..>
/// 2. Vec<...>
///
/// # Warning
/// Though memory safe in the sense that it will not read unowned memory, UB, or memory leaks
/// this function still needs precautions. The returned should never be cloned or taken longer
/// than a single iteration, as every call on `next` of the iterator will change the contents of
/// that Series.
///
/// # Safety
/// The lifetime of [UnstableSeries] is bound to the iterator. Keeping it alive
/// longer than the iterator is UB.
pub unsafe fn amortized_iter(
&self,
) -> AmortizedListIter<impl Iterator<Item = Option<ArrayBox>> + '_> {
self.amortized_iter_with_name("")
}
/// # Safety
/// The lifetime of [UnstableSeries] is bound to the iterator. Keeping it alive
/// longer than the iterator is UB.
pub unsafe fn amortized_iter_with_name(
&self,
name: &str,
) -> AmortizedListIter<impl Iterator<Item = Option<ArrayBox>> + '_> {
// we create the series container from the inner array
// so that the container has the proper dtype.
let arr = self.downcast_iter().next().unwrap();
let inner_values = arr.values();
let inner_dtype = self.inner_dtype();
let iter_dtype = match inner_dtype {
#[cfg(feature = "dtype-struct")]
DataType::Struct(_) => inner_dtype.to_physical(),
// TODO: figure out how to deal with physical/logical distinction
// physical primitives like time, date etc. work
// physical nested need more
_ => inner_dtype.clone(),
};
// Safety:
// inner type passed as physical type
let series_container = unsafe {
let mut s = Series::from_chunks_and_dtype_unchecked(
name,
vec![inner_values.clone()],
&iter_dtype,
);
s.clear_settings();
Box::pin(s)
};
let ptr = series_container.array_ref(0) as *const ArrayRef as *mut ArrayRef;
AmortizedListIter::new(
self.len(),
series_container,
NonNull::new(ptr).unwrap(),
self.downcast_iter().flat_map(|arr| arr.iter()),
inner_dtype,
)
}
/// Apply a closure `F` elementwise.
#[must_use]
pub fn apply_amortized_generic<'a, F, K, V>(&'a self, f: F) -> ChunkedArray<V>
where
V: PolarsDataType,
F: FnMut(Option<UnstableSeries<'a>>) -> Option<K> + Copy,
V::Array: ArrayFromIter<Option<K>>,
{
// TODO! make an amortized iter that does not flatten
// SAFETY: unstable series never lives longer than the iterator.
unsafe { self.amortized_iter().map(f).collect_ca(self.name()) }
}
/// Apply a closure `F` elementwise.
#[must_use]
pub fn apply_amortized<'a, F>(&'a self, mut f: F) -> Self
where
F: FnMut(UnstableSeries<'a>) -> Series,
{
if self.is_empty() {
return self.clone();
}
let mut fast_explode = self.null_count() == 0;
// SAFETY: unstable series never lives longer than the iterator.
let mut ca: ListChunked = unsafe {
self.amortized_iter()
.map(|opt_v| {
opt_v.map(|v| {
let out = f(v);
if out.is_empty() {
fast_explode = false;
}
out
})
})
.collect_trusted()
};
ca.rename(self.name());
if fast_explode {
ca.set_fast_explode();
}
ca
}
pub fn try_apply_amortized<'a, F>(&'a self, mut f: F) -> PolarsResult<Self>
where
F: FnMut(UnstableSeries<'a>) -> PolarsResult<Series>,
{
if self.is_empty() {
return Ok(self.clone());
}
let mut fast_explode = self.null_count() == 0;
// SAFETY: unstable series never lives longer than the iterator.
let mut ca: ListChunked = unsafe {
self.amortized_iter()
.map(|opt_v| {
opt_v
.map(|v| {
let out = f(v);
if let Ok(out) = &out {
if out.is_empty() {
fast_explode = false
}
};
out
})
.transpose()
})
.collect::<PolarsResult<_>>()?
};
ca.rename(self.name());
if fast_explode {
ca.set_fast_explode();
}
Ok(ca)
}
}
#[cfg(test)]
mod test {
use super::*;
use crate::chunked_array::builder::get_list_builder;
#[test]
fn test_iter_list() {
let mut builder = get_list_builder(&DataType::Int32, 10, 10, "").unwrap();
builder.append_series(&Series::new("", &[1, 2, 3])).unwrap();
builder.append_series(&Series::new("", &[3, 2, 1])).unwrap();
builder.append_series(&Series::new("", &[1, 1])).unwrap();
let ca = builder.finish();
// SAFETY: unstable series never lives longer than the iterator.
unsafe {
ca.amortized_iter().zip(&ca).for_each(|(s1, s2)| {
assert!(s1.unwrap().as_ref().series_equal(&s2.unwrap()));
})
};
}
}