polars_core/series/
mod.rs

1#![allow(unsafe_op_in_unsafe_fn)]
2//! Type agnostic columnar data structure.
3use crate::chunked_array::flags::StatisticsFlags;
4pub use crate::prelude::ChunkCompareEq;
5use crate::prelude::*;
6use crate::{HEAD_DEFAULT_LENGTH, TAIL_DEFAULT_LENGTH};
7
8macro_rules! invalid_operation_panic {
9    ($op:ident, $s:expr) => {
10        panic!(
11            "`{}` operation not supported for dtype `{}`",
12            stringify!($op),
13            $s._dtype()
14        )
15    };
16}
17
18pub mod amortized_iter;
19mod any_value;
20pub mod arithmetic;
21pub mod builder;
22#[cfg(feature = "dtype-categorical")]
23pub mod categorical_to_arrow;
24mod comparison;
25mod from;
26pub mod implementations;
27mod into;
28pub use into::ToArrowConverter;
29pub(crate) mod iterator;
30pub mod ops;
31#[cfg(feature = "proptest")]
32pub mod proptest;
33mod series_trait;
34
35use std::borrow::Cow;
36use std::hash::{Hash, Hasher};
37use std::ops::Deref;
38
39use arrow::compute::aggregate::estimated_bytes_size;
40use arrow::offset::Offsets;
41pub use from::*;
42pub use iterator::{SeriesIter, SeriesPhysIter};
43use num_traits::NumCast;
44use polars_error::feature_gated;
45use polars_utils::float::IsFloat;
46pub use series_trait::{IsSorted, *};
47
48use crate::POOL;
49use crate::chunked_array::cast::CastOptions;
50#[cfg(feature = "zip_with")]
51use crate::series::arithmetic::coerce_lhs_rhs;
52use crate::utils::{Wrap, handle_casting_failures, materialize_dyn_int};
53
54/// # Series
55/// The columnar data type for a DataFrame.
56///
57/// Most of the available functions are defined in the [SeriesTrait trait](crate::series::SeriesTrait).
58///
59/// The `Series` struct consists
60/// of typed [ChunkedArray]'s. To quickly cast
61/// a `Series` to a `ChunkedArray` you can call the method with the name of the type:
62///
63/// ```
64/// # use polars_core::prelude::*;
65/// let s: Series = [1, 2, 3].iter().collect();
66/// // Quickly obtain the ChunkedArray wrapped by the Series.
67/// let chunked_array = s.i32().unwrap();
68/// ```
69///
70/// ## Arithmetic
71///
72/// You can do standard arithmetic on series.
73/// ```
74/// # use polars_core::prelude::*;
75/// let s = Series::new("a".into(), [1 , 2, 3]);
76/// let out_add = &s + &s;
77/// let out_sub = &s - &s;
78/// let out_div = &s / &s;
79/// let out_mul = &s * &s;
80/// ```
81///
82/// Or with series and numbers.
83///
84/// ```
85/// # use polars_core::prelude::*;
86/// let s: Series = (1..3).collect();
87/// let out_add_one = &s + 1;
88/// let out_multiply = &s * 10;
89///
90/// // Could not overload left hand side operator.
91/// let out_divide = 1.div(&s);
92/// let out_add = 1.add(&s);
93/// let out_subtract = 1.sub(&s);
94/// let out_multiply = 1.mul(&s);
95/// ```
96///
97/// ## Comparison
98/// You can obtain boolean mask by comparing series.
99///
100/// ```
101/// # use polars_core::prelude::*;
102/// let s = Series::new("dollars".into(), &[1, 2, 3]);
103/// let mask = s.equal(1).unwrap();
104/// let valid = [true, false, false].iter();
105/// assert!(mask
106///     .into_iter()
107///     .map(|opt_bool| opt_bool.unwrap()) // option, because series can be null
108///     .zip(valid)
109///     .all(|(a, b)| a == *b))
110/// ```
111///
112/// See all the comparison operators in the [ChunkCompareEq trait](crate::chunked_array::ops::ChunkCompareEq) and
113/// [ChunkCompareIneq trait](crate::chunked_array::ops::ChunkCompareIneq).
114///
115/// ## Iterators
116/// The Series variants contain differently typed [ChunkedArray]s.
117/// These structs can be turned into iterators, making it possible to use any function/ closure you want
118/// on a Series.
119///
120/// These iterators return an `Option<T>` because the values of a series may be null.
121///
122/// ```
123/// use polars_core::prelude::*;
124/// let pi = 3.14;
125/// let s = Series::new("angle".into(), [2f32 * pi, pi, 1.5 * pi].as_ref());
126/// let s_cos: Series = s.f32()
127///                     .expect("series was not an f32 dtype")
128///                     .into_iter()
129///                     .map(|opt_angle| opt_angle.map(|angle| angle.cos()))
130///                     .collect();
131/// ```
132///
133/// ## Creation
134/// Series can be create from different data structures. Below we'll show a few ways we can create
135/// a Series object.
136///
137/// ```
138/// # use polars_core::prelude::*;
139/// // Series can be created from Vec's, slices and arrays
140/// Series::new("boolean series".into(), &[true, false, true]);
141/// Series::new("int series".into(), &[1, 2, 3]);
142/// // And can be nullable
143/// Series::new("got nulls".into(), &[Some(1), None, Some(2)]);
144///
145/// // Series can also be collected from iterators
146/// let from_iter: Series = (0..10)
147///     .into_iter()
148///     .collect();
149///
150/// ```
151#[derive(Clone)]
152#[must_use]
153pub struct Series(pub Arc<dyn SeriesTrait>);
154
155impl PartialEq for Wrap<Series> {
156    fn eq(&self, other: &Self) -> bool {
157        self.0.equals_missing(other)
158    }
159}
160
161impl Eq for Wrap<Series> {}
162
163impl Hash for Wrap<Series> {
164    fn hash<H: Hasher>(&self, state: &mut H) {
165        let rs = PlSeedableRandomStateQuality::fixed();
166        let mut h = vec![];
167        if self.0.vec_hash(rs, &mut h).is_ok() {
168            let h = h.into_iter().fold(0, |a: u64, b| a.wrapping_add(b));
169            h.hash(state)
170        } else {
171            self.len().hash(state);
172            self.null_count().hash(state);
173            self.dtype().hash(state);
174        }
175    }
176}
177
178impl Series {
179    /// Create a new empty Series.
180    pub fn new_empty(name: PlSmallStr, dtype: &DataType) -> Series {
181        Series::full_null(name, 0, dtype)
182    }
183
184    pub fn clear(&self) -> Series {
185        if self.is_empty() {
186            self.clone()
187        } else {
188            match self.dtype() {
189                #[cfg(feature = "object")]
190                DataType::Object(_) => self
191                    .take(&ChunkedArray::<IdxType>::new_vec(PlSmallStr::EMPTY, vec![]))
192                    .unwrap(),
193                dt => Series::new_empty(self.name().clone(), dt),
194            }
195        }
196    }
197
198    #[doc(hidden)]
199    pub fn _get_inner_mut(&mut self) -> &mut dyn SeriesTrait {
200        if Arc::weak_count(&self.0) + Arc::strong_count(&self.0) != 1 {
201            self.0 = self.0.clone_inner();
202        }
203        Arc::get_mut(&mut self.0).expect("implementation error")
204    }
205
206    /// Take or clone a owned copy of the inner [`ChunkedArray`].
207    pub fn take_inner<T: PolarsPhysicalType>(self) -> ChunkedArray<T> {
208        let arc_any = self.0.as_arc_any();
209        let downcast = arc_any
210            .downcast::<implementations::SeriesWrap<ChunkedArray<T>>>()
211            .unwrap();
212
213        match Arc::try_unwrap(downcast) {
214            Ok(ca) => ca.0,
215            Err(ca) => ca.as_ref().as_ref().clone(),
216        }
217    }
218
219    /// # Safety
220    /// The caller must ensure the length and the data types of `ArrayRef` does not change.
221    /// And that the null_count is updated (e.g. with a `compute_len()`)
222    pub unsafe fn chunks_mut(&mut self) -> &mut Vec<ArrayRef> {
223        #[allow(unused_mut)]
224        let mut ca = self._get_inner_mut();
225        ca.chunks_mut()
226    }
227
228    pub fn into_chunks(mut self) -> Vec<ArrayRef> {
229        let ca = self._get_inner_mut();
230        let chunks = std::mem::take(unsafe { ca.chunks_mut() });
231        ca.compute_len();
232        chunks
233    }
234
235    // TODO! this probably can now be removed, now we don't have special case for structs.
236    pub fn select_chunk(&self, i: usize) -> Self {
237        let mut new = self.clear();
238        let mut flags = self.get_flags();
239
240        use StatisticsFlags as F;
241        flags &= F::IS_SORTED_ANY | F::CAN_FAST_EXPLODE_LIST;
242
243        // Assign mut so we go through arc only once.
244        let mut_new = new._get_inner_mut();
245        let chunks = unsafe { mut_new.chunks_mut() };
246        let chunk = self.chunks()[i].clone();
247        chunks.clear();
248        chunks.push(chunk);
249        mut_new.compute_len();
250        mut_new._set_flags(flags);
251        new
252    }
253
254    pub fn is_sorted_flag(&self) -> IsSorted {
255        if self.len() <= 1 {
256            return IsSorted::Ascending;
257        }
258        self.get_flags().is_sorted()
259    }
260
261    pub fn set_sorted_flag(&mut self, sorted: IsSorted) {
262        let mut flags = self.get_flags();
263        flags.set_sorted(sorted);
264        self.set_flags(flags);
265    }
266
267    pub(crate) fn clear_flags(&mut self) {
268        self.set_flags(StatisticsFlags::empty());
269    }
270    pub fn get_flags(&self) -> StatisticsFlags {
271        self.0._get_flags()
272    }
273
274    pub(crate) fn set_flags(&mut self, flags: StatisticsFlags) {
275        self._get_inner_mut()._set_flags(flags)
276    }
277
278    pub fn into_frame(self) -> DataFrame {
279        // SAFETY: A single-column dataframe cannot have length mismatches or duplicate names
280        unsafe { DataFrame::new_no_checks(self.len(), vec![self.into()]) }
281    }
282
283    /// Rename series.
284    pub fn rename(&mut self, name: PlSmallStr) -> &mut Series {
285        self._get_inner_mut().rename(name);
286        self
287    }
288
289    /// Return this Series with a new name.
290    pub fn with_name(mut self, name: PlSmallStr) -> Series {
291        self.rename(name);
292        self
293    }
294
295    pub fn from_arrow_chunks(name: PlSmallStr, arrays: Vec<ArrayRef>) -> PolarsResult<Series> {
296        Self::try_from((name, arrays))
297    }
298
299    pub fn from_arrow(name: PlSmallStr, array: ArrayRef) -> PolarsResult<Series> {
300        Self::try_from((name, array))
301    }
302
303    /// Shrink the capacity of this array to fit its length.
304    pub fn shrink_to_fit(&mut self) {
305        self._get_inner_mut().shrink_to_fit()
306    }
307
308    /// Append in place. This is done by adding the chunks of `other` to this [`Series`].
309    ///
310    /// See [`ChunkedArray::append`] and [`ChunkedArray::extend`].
311    pub fn append(&mut self, other: &Series) -> PolarsResult<&mut Self> {
312        let must_cast = other.dtype().matches_schema_type(self.dtype())?;
313        if must_cast {
314            let other = other.cast(self.dtype())?;
315            self.append_owned(other)?;
316        } else {
317            self._get_inner_mut().append(other)?;
318        }
319        Ok(self)
320    }
321
322    /// Append in place. This is done by adding the chunks of `other` to this [`Series`].
323    ///
324    /// See [`ChunkedArray::append_owned`] and [`ChunkedArray::extend`].
325    pub fn append_owned(&mut self, other: Series) -> PolarsResult<&mut Self> {
326        let must_cast = other.dtype().matches_schema_type(self.dtype())?;
327        if must_cast {
328            let other = other.cast(self.dtype())?;
329            self._get_inner_mut().append_owned(other)?;
330        } else {
331            self._get_inner_mut().append_owned(other)?;
332        }
333        Ok(self)
334    }
335
336    /// Redo a length and null_count compute
337    pub fn compute_len(&mut self) {
338        self._get_inner_mut().compute_len()
339    }
340
341    /// Extend the memory backed by this array with the values from `other`.
342    ///
343    /// See [`ChunkedArray::extend`] and [`ChunkedArray::append`].
344    pub fn extend(&mut self, other: &Series) -> PolarsResult<&mut Self> {
345        let must_cast = other.dtype().matches_schema_type(self.dtype())?;
346        if must_cast {
347            let other = other.cast(self.dtype())?;
348            self._get_inner_mut().extend(&other)?;
349        } else {
350            self._get_inner_mut().extend(other)?;
351        }
352        Ok(self)
353    }
354
355    /// Sort the series with specific options.
356    ///
357    /// # Example
358    ///
359    /// ```rust
360    /// # use polars_core::prelude::*;
361    /// # fn main() -> PolarsResult<()> {
362    /// let s = Series::new("foo".into(), [2, 1, 3]);
363    /// let sorted = s.sort(SortOptions::default())?;
364    /// assert_eq!(sorted, Series::new("foo".into(), [1, 2, 3]));
365    /// # Ok(())
366    /// }
367    /// ```
368    ///
369    /// See [`SortOptions`] for more options.
370    pub fn sort(&self, sort_options: SortOptions) -> PolarsResult<Self> {
371        self.sort_with(sort_options)
372    }
373
374    /// Only implemented for numeric types
375    pub fn as_single_ptr(&mut self) -> PolarsResult<usize> {
376        self._get_inner_mut().as_single_ptr()
377    }
378
379    pub fn cast(&self, dtype: &DataType) -> PolarsResult<Self> {
380        self.cast_with_options(dtype, CastOptions::NonStrict)
381    }
382
383    /// Cast [`Series`] to another [`DataType`].
384    pub fn cast_with_options(&self, dtype: &DataType, options: CastOptions) -> PolarsResult<Self> {
385        let slf = self
386            .trim_lists_to_normalized_offsets()
387            .map_or(Cow::Borrowed(self), Cow::Owned);
388        let slf = slf.propagate_nulls().map_or(slf, Cow::Owned);
389
390        use DataType as D;
391        let do_clone = match dtype {
392            D::Unknown(UnknownKind::Any) => true,
393            D::Unknown(UnknownKind::Int(_)) if slf.dtype().is_integer() => true,
394            D::Unknown(UnknownKind::Float) if slf.dtype().is_float() => true,
395            D::Unknown(UnknownKind::Str)
396                if slf.dtype().is_string() | slf.dtype().is_categorical() =>
397            {
398                true
399            },
400            dt if (dt.is_primitive() || dt.is_extension()) && dt == slf.dtype() => true,
401            _ => false,
402        };
403
404        if do_clone {
405            return Ok(slf.into_owned());
406        }
407
408        pub fn cast_dtype(dtype: &DataType) -> Option<DataType> {
409            match dtype {
410                D::Unknown(UnknownKind::Int(v)) => Some(materialize_dyn_int(*v).dtype()),
411                D::Unknown(UnknownKind::Float) => Some(DataType::Float64),
412                D::Unknown(UnknownKind::Str) => Some(DataType::String),
413                // Best leave as is.
414                D::List(inner) => cast_dtype(inner.as_ref()).map(Box::new).map(D::List),
415                #[cfg(feature = "dtype-struct")]
416                D::Struct(fields) => {
417                    // @NOTE: We only allocate if we really need to.
418
419                    let mut field_iter = fields.iter().enumerate();
420                    let mut new_fields = loop {
421                        let (i, field) = field_iter.next()?;
422
423                        if let Some(dtype) = cast_dtype(&field.dtype) {
424                            let mut new_fields = Vec::with_capacity(fields.len());
425                            new_fields.extend(fields.iter().take(i).cloned());
426                            new_fields.push(Field {
427                                name: field.name.clone(),
428                                dtype,
429                            });
430                            break new_fields;
431                        }
432                    };
433
434                    new_fields.extend(fields.iter().skip(new_fields.len()).cloned().map(|field| {
435                        let dtype = cast_dtype(&field.dtype).unwrap_or(field.dtype);
436                        Field {
437                            name: field.name,
438                            dtype,
439                        }
440                    }));
441
442                    Some(D::Struct(new_fields))
443                },
444                _ => None,
445            }
446        }
447
448        let mut casted = cast_dtype(dtype);
449        if dtype.is_list() && dtype.inner_dtype().is_some_and(|dt| dt.is_null()) {
450            if let Some(from_inner_dtype) = slf.dtype().inner_dtype() {
451                casted = Some(DataType::List(Box::new(from_inner_dtype.clone())));
452            }
453        }
454        let dtype = match casted {
455            None => dtype,
456            Some(ref dtype) => dtype,
457        };
458
459        // Always allow casting all nulls to other all nulls.
460        let len = slf.len();
461        if slf.null_count() == len {
462            return Ok(Series::full_null(slf.name().clone(), len, dtype));
463        }
464
465        let new_options = match options {
466            // Strictness is handled on this level to improve error messages.
467            CastOptions::Strict => CastOptions::NonStrict,
468            opt => opt,
469        };
470
471        let out = slf.0.cast(dtype, new_options)?;
472        if options.is_strict() {
473            handle_casting_failures(slf.as_ref(), &out)?;
474        }
475        Ok(out)
476    }
477
478    /// Cast from physical to logical types without any checks on the validity of the cast.
479    ///
480    /// # Safety
481    ///
482    /// This can lead to invalid memory access in downstream code.
483    pub unsafe fn cast_unchecked(&self, dtype: &DataType) -> PolarsResult<Self> {
484        match self.dtype() {
485            #[cfg(feature = "dtype-struct")]
486            DataType::Struct(_) => self.struct_().unwrap().cast_unchecked(dtype),
487            DataType::List(_) => self.list().unwrap().cast_unchecked(dtype),
488            dt if dt.is_primitive_numeric() => {
489                with_match_physical_numeric_polars_type!(dt, |$T| {
490                    let ca: &ChunkedArray<$T> = self.as_ref().as_ref().as_ref();
491                        ca.cast_unchecked(dtype)
492                })
493            },
494            DataType::Binary => self.binary().unwrap().cast_unchecked(dtype),
495            _ => self.cast_with_options(dtype, CastOptions::Overflowing),
496        }
497    }
498
499    /// Convert a non-logical series back into a logical series without casting.
500    ///
501    /// # Safety
502    ///
503    /// This can lead to invalid memory access in downstream code.
504    pub unsafe fn from_physical_unchecked(&self, dtype: &DataType) -> PolarsResult<Self> {
505        debug_assert!(!self.dtype().is_logical(), "{:?}", self.dtype());
506
507        if self.dtype() == dtype {
508            return Ok(self.clone());
509        }
510
511        use DataType as D;
512        match (self.dtype(), dtype) {
513            #[cfg(feature = "dtype-decimal")]
514            (D::Int128, D::Decimal(precision, scale)) => {
515                let ca = self.i128().unwrap();
516                Ok(ca
517                    .clone()
518                    .into_decimal_unchecked(*precision, *scale)
519                    .into_series())
520            },
521
522            #[cfg(feature = "dtype-categorical")]
523            (phys, D::Categorical(cats, _)) if &cats.physical().dtype() == phys => {
524                with_match_categorical_physical_type!(cats.physical(), |$C| {
525                    type CA = ChunkedArray<<$C as PolarsCategoricalType>::PolarsPhysical>;
526                    let ca = self.as_ref().as_any().downcast_ref::<CA>().unwrap();
527                    Ok(CategoricalChunked::<$C>::from_cats_and_dtype_unchecked(
528                        ca.clone(),
529                        dtype.clone(),
530                    )
531                    .into_series())
532                })
533            },
534            #[cfg(feature = "dtype-categorical")]
535            (phys, D::Enum(fcats, _)) if &fcats.physical().dtype() == phys => {
536                with_match_categorical_physical_type!(fcats.physical(), |$C| {
537                    type CA = ChunkedArray<<$C as PolarsCategoricalType>::PolarsPhysical>;
538                    let ca = self.as_ref().as_any().downcast_ref::<CA>().unwrap();
539                    Ok(CategoricalChunked::<$C>::from_cats_and_dtype_unchecked(
540                        ca.clone(),
541                        dtype.clone(),
542                    )
543                    .into_series())
544                })
545            },
546
547            (D::Int32, D::Date) => feature_gated!("dtype-time", Ok(self.clone().into_date())),
548            (D::Int64, D::Datetime(tu, tz)) => feature_gated!(
549                "dtype-datetime",
550                Ok(self.clone().into_datetime(*tu, tz.clone()))
551            ),
552            (D::Int64, D::Duration(tu)) => {
553                feature_gated!("dtype-duration", Ok(self.clone().into_duration(*tu)))
554            },
555            (D::Int64, D::Time) => feature_gated!("dtype-time", Ok(self.clone().into_time())),
556
557            (D::List(_), D::List(to)) => unsafe {
558                self.list()
559                    .unwrap()
560                    .from_physical_unchecked(to.as_ref().clone())
561                    .map(|ca| ca.into_series())
562            },
563            #[cfg(feature = "dtype-array")]
564            (D::Array(_, lw), D::Array(to, rw)) if lw == rw => unsafe {
565                self.array()
566                    .unwrap()
567                    .from_physical_unchecked(to.as_ref().clone())
568                    .map(|ca| ca.into_series())
569            },
570            #[cfg(feature = "dtype-struct")]
571            (D::Struct(_), D::Struct(to)) => unsafe {
572                self.struct_()
573                    .unwrap()
574                    .from_physical_unchecked(to.as_slice())
575                    .map(|ca| ca.into_series())
576            },
577
578            #[cfg(feature = "dtype-extension")]
579            (_, D::Extension(typ, storage)) => {
580                let storage_series = self.from_physical_unchecked(storage.as_ref())?;
581                let ext = ExtensionChunked::from_storage(typ.clone(), storage_series);
582                Ok(ext.into_series())
583            },
584
585            _ => panic!("invalid from_physical({dtype:?}) for {:?}", self.dtype()),
586        }
587    }
588
589    #[cfg(feature = "dtype-extension")]
590    pub fn into_extension(self, typ: ExtensionTypeInstance) -> Series {
591        assert!(!self.dtype().is_extension());
592        let ext = ExtensionChunked::from_storage(typ, self);
593        ext.into_series()
594    }
595
596    /// Cast numerical types to f64, and keep floats as is.
597    pub fn to_float(&self) -> PolarsResult<Series> {
598        match self.dtype() {
599            DataType::Float32 | DataType::Float64 => Ok(self.clone()),
600            _ => self.cast_with_options(&DataType::Float64, CastOptions::Overflowing),
601        }
602    }
603
604    /// Compute the sum of all values in this Series.
605    /// Returns `Some(0)` if the array is empty, and `None` if the array only
606    /// contains null values.
607    ///
608    /// If the [`DataType`] is one of `{Int8, UInt8, Int16, UInt16}` the `Series` is
609    /// first cast to `Int64` to prevent overflow issues.
610    pub fn sum<T>(&self) -> PolarsResult<T>
611    where
612        T: NumCast + IsFloat,
613    {
614        let sum = self.sum_reduce()?;
615        let sum = sum.value().extract().unwrap();
616        Ok(sum)
617    }
618
619    /// Returns the minimum value in the array, according to the natural order.
620    /// Returns an option because the array is nullable.
621    pub fn min<T>(&self) -> PolarsResult<Option<T>>
622    where
623        T: NumCast + IsFloat,
624    {
625        let min = self.min_reduce()?;
626        let min = min.value().extract::<T>();
627        Ok(min)
628    }
629
630    /// Returns the maximum value in the array, according to the natural order.
631    /// Returns an option because the array is nullable.
632    pub fn max<T>(&self) -> PolarsResult<Option<T>>
633    where
634        T: NumCast + IsFloat,
635    {
636        let max = self.max_reduce()?;
637        let max = max.value().extract::<T>();
638        Ok(max)
639    }
640
641    /// Explode a list Series. This expands every item to a new row..
642    pub fn explode(&self, options: ExplodeOptions) -> PolarsResult<Series> {
643        match self.dtype() {
644            DataType::List(_) => self.list().unwrap().explode(options),
645            #[cfg(feature = "dtype-array")]
646            DataType::Array(_, _) => self.array().unwrap().explode(options),
647            _ => Ok(self.clone()),
648        }
649    }
650
651    /// Check if numeric value is NaN (note this is different than missing/ null)
652    pub fn is_nan(&self) -> PolarsResult<BooleanChunked> {
653        match self.dtype() {
654            #[cfg(feature = "dtype-f16")]
655            DataType::Float16 => Ok(self.f16().unwrap().is_nan()),
656            DataType::Float32 => Ok(self.f32().unwrap().is_nan()),
657            DataType::Float64 => Ok(self.f64().unwrap().is_nan()),
658            DataType::Null => Ok(BooleanChunked::full_null(self.name().clone(), self.len())),
659            dt if dt.is_primitive_numeric() => {
660                let arr = BooleanArray::full(self.len(), false, ArrowDataType::Boolean)
661                    .with_validity(self.rechunk_validity());
662                Ok(BooleanChunked::with_chunk(self.name().clone(), arr))
663            },
664            _ => polars_bail!(opq = is_nan, self.dtype()),
665        }
666    }
667
668    /// Check if numeric value is NaN (note this is different than missing/null)
669    pub fn is_not_nan(&self) -> PolarsResult<BooleanChunked> {
670        match self.dtype() {
671            #[cfg(feature = "dtype-f16")]
672            DataType::Float16 => Ok(self.f16().unwrap().is_not_nan()),
673            DataType::Float32 => Ok(self.f32().unwrap().is_not_nan()),
674            DataType::Float64 => Ok(self.f64().unwrap().is_not_nan()),
675            dt if dt.is_primitive_numeric() => {
676                let arr = BooleanArray::full(self.len(), true, ArrowDataType::Boolean)
677                    .with_validity(self.rechunk_validity());
678                Ok(BooleanChunked::with_chunk(self.name().clone(), arr))
679            },
680            _ => polars_bail!(opq = is_not_nan, self.dtype()),
681        }
682    }
683
684    /// Check if numeric value is finite
685    pub fn is_finite(&self) -> PolarsResult<BooleanChunked> {
686        match self.dtype() {
687            #[cfg(feature = "dtype-f16")]
688            DataType::Float16 => Ok(self.f16().unwrap().is_finite()),
689            DataType::Float32 => Ok(self.f32().unwrap().is_finite()),
690            DataType::Float64 => Ok(self.f64().unwrap().is_finite()),
691            DataType::Null => Ok(BooleanChunked::full_null(self.name().clone(), self.len())),
692            dt if dt.is_primitive_numeric() => {
693                let arr = BooleanArray::full(self.len(), true, ArrowDataType::Boolean)
694                    .with_validity(self.rechunk_validity());
695                Ok(BooleanChunked::with_chunk(self.name().clone(), arr))
696            },
697            _ => polars_bail!(opq = is_finite, self.dtype()),
698        }
699    }
700
701    /// Check if numeric value is infinite
702    pub fn is_infinite(&self) -> PolarsResult<BooleanChunked> {
703        match self.dtype() {
704            #[cfg(feature = "dtype-f16")]
705            DataType::Float16 => Ok(self.f16().unwrap().is_infinite()),
706            DataType::Float32 => Ok(self.f32().unwrap().is_infinite()),
707            DataType::Float64 => Ok(self.f64().unwrap().is_infinite()),
708            DataType::Null => Ok(BooleanChunked::full_null(self.name().clone(), self.len())),
709            dt if dt.is_primitive_numeric() => {
710                let arr = BooleanArray::full(self.len(), false, ArrowDataType::Boolean)
711                    .with_validity(self.rechunk_validity());
712                Ok(BooleanChunked::with_chunk(self.name().clone(), arr))
713            },
714            _ => polars_bail!(opq = is_infinite, self.dtype()),
715        }
716    }
717
718    /// Create a new ChunkedArray with values from self where the mask evaluates `true` and values
719    /// from `other` where the mask evaluates `false`. This function automatically broadcasts unit
720    /// length inputs.
721    #[cfg(feature = "zip_with")]
722    pub fn zip_with(&self, mask: &BooleanChunked, other: &Series) -> PolarsResult<Series> {
723        let (lhs, rhs) = coerce_lhs_rhs(self, other)?;
724        lhs.zip_with_same_type(mask, rhs.as_ref())
725    }
726
727    /// Converts a Series to their physical representation, if they have one,
728    /// otherwise the series is left unchanged.
729    ///
730    /// * Date -> Int32
731    /// * Datetime -> Int64
732    /// * Duration -> Int64
733    /// * Decimal -> Int128
734    /// * Time -> Int64
735    /// * Categorical -> U8/U16/U32
736    /// * List(inner) -> List(physical of inner)
737    /// * Array(inner) -> Array(physical of inner)
738    /// * Struct -> Struct with physical repr of each struct column
739    /// * Extension -> physical of storage type
740    pub fn to_physical_repr(&self) -> Cow<'_, Series> {
741        use DataType::*;
742        match self.dtype() {
743            // NOTE: Don't use cast here, as it might rechunk (if all nulls)
744            // which is not allowed in a phys repr.
745            #[cfg(feature = "dtype-date")]
746            Date => Cow::Owned(self.date().unwrap().phys.clone().into_series()),
747            #[cfg(feature = "dtype-datetime")]
748            Datetime(_, _) => Cow::Owned(self.datetime().unwrap().phys.clone().into_series()),
749            #[cfg(feature = "dtype-duration")]
750            Duration(_) => Cow::Owned(self.duration().unwrap().phys.clone().into_series()),
751            #[cfg(feature = "dtype-time")]
752            Time => Cow::Owned(self.time().unwrap().phys.clone().into_series()),
753            #[cfg(feature = "dtype-categorical")]
754            dt @ (Categorical(_, _) | Enum(_, _)) => {
755                with_match_categorical_physical_type!(dt.cat_physical().unwrap(), |$C| {
756                    let ca = self.cat::<$C>().unwrap();
757                    Cow::Owned(ca.physical().clone().into_series())
758                })
759            },
760            #[cfg(feature = "dtype-decimal")]
761            Decimal(_, _) => Cow::Owned(self.decimal().unwrap().phys.clone().into_series()),
762            List(_) => match self.list().unwrap().to_physical_repr() {
763                Cow::Borrowed(_) => Cow::Borrowed(self),
764                Cow::Owned(ca) => Cow::Owned(ca.into_series()),
765            },
766            #[cfg(feature = "dtype-array")]
767            Array(_, _) => match self.array().unwrap().to_physical_repr() {
768                Cow::Borrowed(_) => Cow::Borrowed(self),
769                Cow::Owned(ca) => Cow::Owned(ca.into_series()),
770            },
771            #[cfg(feature = "dtype-struct")]
772            Struct(_) => match self.struct_().unwrap().to_physical_repr() {
773                Cow::Borrowed(_) => Cow::Borrowed(self),
774                Cow::Owned(ca) => Cow::Owned(ca.into_series()),
775            },
776            #[cfg(feature = "dtype-extension")]
777            Extension(_, _) => self.ext().unwrap().storage().to_physical_repr(),
778            _ => Cow::Borrowed(self),
779        }
780    }
781
782    /// If the Series is an Extension type, return its storage Series.
783    /// Otherwise, return itself.
784    pub fn to_storage(&self) -> &Series {
785        #[cfg(feature = "dtype-extension")]
786        {
787            if let DataType::Extension(_, _) = self.dtype() {
788                return self.ext().unwrap().storage();
789            }
790        }
791        self
792    }
793
794    /// Traverse and collect every nth element in a new array.
795    pub fn gather_every(&self, n: usize, offset: usize) -> PolarsResult<Series> {
796        polars_ensure!(n > 0, ComputeError: "cannot perform gather every for `n=0`");
797        let idx = ((offset as IdxSize)..self.len() as IdxSize)
798            .step_by(n)
799            .collect_ca(PlSmallStr::EMPTY);
800        // SAFETY: we stay in-bounds.
801        Ok(unsafe { self.take_unchecked(&idx) })
802    }
803
804    #[cfg(feature = "dot_product")]
805    pub fn dot(&self, other: &Series) -> PolarsResult<f64> {
806        std::ops::Mul::mul(self, other)?.sum::<f64>()
807    }
808
809    /// Get the sum of the Series as a new Series of length 1.
810    /// Returns a Series with a single zeroed entry if self is an empty numeric series.
811    ///
812    /// If the [`DataType`] is one of `{Int8, UInt8, Int16, UInt16}` the `Series` is
813    /// first cast to `Int64` to prevent overflow issues.
814    pub fn sum_reduce(&self) -> PolarsResult<Scalar> {
815        use DataType::*;
816        match self.dtype() {
817            Int8 | UInt8 | Int16 | UInt16 => self.cast(&Int64).unwrap().sum_reduce(),
818            _ => self.0.sum_reduce(),
819        }
820    }
821
822    /// Get the mean of the Series as a new Series of length 1.
823    /// Returns a Series with a single null entry if self is an empty numeric series.
824    pub fn mean_reduce(&self) -> PolarsResult<Scalar> {
825        self.0.mean_reduce()
826    }
827
828    /// Get the product of an array.
829    ///
830    /// If the [`DataType`] is one of `{Int8, UInt8, Int16, UInt16}` the `Series` is
831    /// first cast to `Int64` to prevent overflow issues.
832    pub fn product(&self) -> PolarsResult<Scalar> {
833        #[cfg(feature = "product")]
834        {
835            use DataType::*;
836            match self.dtype() {
837                Boolean => self.cast(&DataType::Int64).unwrap().product(),
838                Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 => {
839                    let s = self.cast(&Int64).unwrap();
840                    s.product()
841                },
842                Int64 => Ok(self.i64().unwrap().prod_reduce()),
843                UInt64 => Ok(self.u64().unwrap().prod_reduce()),
844                #[cfg(feature = "dtype-i128")]
845                Int128 => Ok(self.i128().unwrap().prod_reduce()),
846                #[cfg(feature = "dtype-u128")]
847                UInt128 => Ok(self.u128().unwrap().prod_reduce()),
848                #[cfg(feature = "dtype-f16")]
849                Float16 => Ok(self.f16().unwrap().prod_reduce()),
850                Float32 => Ok(self.f32().unwrap().prod_reduce()),
851                Float64 => Ok(self.f64().unwrap().prod_reduce()),
852                dt => {
853                    polars_bail!(InvalidOperation: "`product` operation not supported for dtype `{dt}`")
854                },
855            }
856        }
857        #[cfg(not(feature = "product"))]
858        {
859            panic!("activate 'product' feature")
860        }
861    }
862
863    /// Cast throws an error if conversion had overflows
864    pub fn strict_cast(&self, dtype: &DataType) -> PolarsResult<Series> {
865        self.cast_with_options(dtype, CastOptions::Strict)
866    }
867
868    #[cfg(feature = "dtype-decimal")]
869    pub fn into_decimal(self, precision: usize, scale: usize) -> PolarsResult<Series> {
870        match self.dtype() {
871            DataType::Int128 => Ok(self
872                .i128()
873                .unwrap()
874                .clone()
875                .into_decimal(precision, scale)?
876                .into_series()),
877            DataType::Decimal(cur_prec, cur_scale)
878                if scale == *cur_scale && precision >= *cur_prec =>
879            {
880                Ok(self)
881            },
882            dt => panic!("into_decimal({precision:?}, {scale}) not implemented for {dt:?}"),
883        }
884    }
885
886    #[cfg(feature = "dtype-time")]
887    pub fn into_time(self) -> Series {
888        match self.dtype() {
889            DataType::Int64 => self.i64().unwrap().clone().into_time().into_series(),
890            DataType::Time => self
891                .time()
892                .unwrap()
893                .physical()
894                .clone()
895                .into_time()
896                .into_series(),
897            dt => panic!("date not implemented for {dt:?}"),
898        }
899    }
900
901    pub fn into_date(self) -> Series {
902        #[cfg(not(feature = "dtype-date"))]
903        {
904            panic!("activate feature dtype-date")
905        }
906        #[cfg(feature = "dtype-date")]
907        match self.dtype() {
908            DataType::Int32 => self.i32().unwrap().clone().into_date().into_series(),
909            DataType::Date => self
910                .date()
911                .unwrap()
912                .physical()
913                .clone()
914                .into_date()
915                .into_series(),
916            dt => panic!("date not implemented for {dt:?}"),
917        }
918    }
919
920    #[allow(unused_variables)]
921    pub fn into_datetime(self, timeunit: TimeUnit, tz: Option<TimeZone>) -> Series {
922        #[cfg(not(feature = "dtype-datetime"))]
923        {
924            panic!("activate feature dtype-datetime")
925        }
926
927        #[cfg(feature = "dtype-datetime")]
928        match self.dtype() {
929            DataType::Int64 => self
930                .i64()
931                .unwrap()
932                .clone()
933                .into_datetime(timeunit, tz)
934                .into_series(),
935            DataType::Datetime(_, _) => self
936                .datetime()
937                .unwrap()
938                .physical()
939                .clone()
940                .into_datetime(timeunit, tz)
941                .into_series(),
942            dt => panic!("into_datetime not implemented for {dt:?}"),
943        }
944    }
945
946    #[allow(unused_variables)]
947    pub fn into_duration(self, timeunit: TimeUnit) -> Series {
948        #[cfg(not(feature = "dtype-duration"))]
949        {
950            panic!("activate feature dtype-duration")
951        }
952        #[cfg(feature = "dtype-duration")]
953        match self.dtype() {
954            DataType::Int64 => self
955                .i64()
956                .unwrap()
957                .clone()
958                .into_duration(timeunit)
959                .into_series(),
960            DataType::Duration(_) => self
961                .duration()
962                .unwrap()
963                .physical()
964                .clone()
965                .into_duration(timeunit)
966                .into_series(),
967            dt => panic!("into_duration not implemented for {dt:?}"),
968        }
969    }
970
971    // used for formatting
972    pub fn str_value(&self, index: usize) -> PolarsResult<Cow<'_, str>> {
973        Ok(self.0.get(index)?.str_value())
974    }
975    /// Get the head of the Series.
976    pub fn head(&self, length: Option<usize>) -> Series {
977        let len = length.unwrap_or(HEAD_DEFAULT_LENGTH);
978        self.slice(0, std::cmp::min(len, self.len()))
979    }
980
981    /// Get the tail of the Series.
982    pub fn tail(&self, length: Option<usize>) -> Series {
983        let len = length.unwrap_or(TAIL_DEFAULT_LENGTH);
984        let len = std::cmp::min(len, self.len());
985        self.slice(-(len as i64), len)
986    }
987
988    /// Compute the unique elements, but maintain order. This requires more work
989    /// than a naive [`Series::unique`](SeriesTrait::unique).
990    pub fn unique_stable(&self) -> PolarsResult<Series> {
991        let idx = self.arg_unique()?;
992        // SAFETY: Indices are in bounds.
993        unsafe { Ok(self.take_unchecked(&idx)) }
994    }
995
996    pub fn try_idx(&self) -> Option<&IdxCa> {
997        #[cfg(feature = "bigidx")]
998        {
999            self.try_u64()
1000        }
1001        #[cfg(not(feature = "bigidx"))]
1002        {
1003            self.try_u32()
1004        }
1005    }
1006
1007    pub fn idx(&self) -> PolarsResult<&IdxCa> {
1008        #[cfg(feature = "bigidx")]
1009        {
1010            self.u64()
1011        }
1012        #[cfg(not(feature = "bigidx"))]
1013        {
1014            self.u32()
1015        }
1016    }
1017
1018    /// Returns an estimation of the total (heap) allocated size of the `Series` in bytes.
1019    ///
1020    /// # Implementation
1021    /// This estimation is the sum of the size of its buffers, validity, including nested arrays.
1022    /// Multiple arrays may share buffers and bitmaps. Therefore, the size of 2 arrays is not the
1023    /// sum of the sizes computed from this function. In particular, [`StructArray`]'s size is an upper bound.
1024    ///
1025    /// When an array is sliced, its allocated size remains constant because the buffer unchanged.
1026    /// However, this function will yield a smaller number. This is because this function returns
1027    /// the visible size of the buffer, not its total capacity.
1028    ///
1029    /// FFI buffers are included in this estimation.
1030    pub fn estimated_size(&self) -> usize {
1031        let mut size = 0;
1032        match self.dtype() {
1033            // TODO @ cat-rework: include mapping size here?
1034            #[cfg(feature = "object")]
1035            DataType::Object(_) => {
1036                let ArrowDataType::FixedSizeBinary(size) = self.chunks()[0].dtype() else {
1037                    unreachable!()
1038                };
1039                // This is only the pointer size in python. So will be a huge underestimation.
1040                return self.len() * *size;
1041            },
1042            _ => {},
1043        }
1044
1045        size += self
1046            .chunks()
1047            .iter()
1048            .map(|arr| estimated_bytes_size(&**arr))
1049            .sum::<usize>();
1050
1051        size
1052    }
1053
1054    /// Packs every element into a list.
1055    pub fn as_list(&self) -> ListChunked {
1056        let s = self.rechunk();
1057        // don't  use `to_arrow` as we need the physical types
1058        let values = s.chunks()[0].clone();
1059        let offsets = (0i64..(s.len() as i64 + 1)).collect::<Vec<_>>();
1060        let offsets = unsafe { Offsets::new_unchecked(offsets) };
1061
1062        let dtype = LargeListArray::default_datatype(
1063            s.dtype().to_physical().to_arrow(CompatLevel::newest()),
1064        );
1065        let new_arr = LargeListArray::new(dtype, offsets.into(), values, None);
1066        let mut out = ListChunked::with_chunk(s.name().clone(), new_arr);
1067        out.set_inner_dtype(s.dtype().clone());
1068        out
1069    }
1070
1071    pub fn row_encode_unordered(&self) -> PolarsResult<BinaryOffsetChunked> {
1072        row_encode::_get_rows_encoded_ca_unordered(
1073            self.name().clone(),
1074            &[self.clone().into_column()],
1075        )
1076    }
1077
1078    pub fn row_encode_ordered(
1079        &self,
1080        descending: bool,
1081        nulls_last: bool,
1082    ) -> PolarsResult<BinaryOffsetChunked> {
1083        row_encode::_get_rows_encoded_ca(
1084            self.name().clone(),
1085            &[self.clone().into_column()],
1086            &[descending],
1087            &[nulls_last],
1088        )
1089    }
1090}
1091
1092impl Deref for Series {
1093    type Target = dyn SeriesTrait;
1094
1095    fn deref(&self) -> &Self::Target {
1096        self.0.as_ref()
1097    }
1098}
1099
1100impl<'a> AsRef<dyn SeriesTrait + 'a> for Series {
1101    fn as_ref(&self) -> &(dyn SeriesTrait + 'a) {
1102        self.0.as_ref()
1103    }
1104}
1105
1106impl Default for Series {
1107    fn default() -> Self {
1108        Int64Chunked::default().into_series()
1109    }
1110}
1111
1112impl<T: PolarsPhysicalType> AsRef<ChunkedArray<T>> for dyn SeriesTrait + '_ {
1113    fn as_ref(&self) -> &ChunkedArray<T> {
1114        // @NOTE: SeriesTrait `as_any` returns a std::any::Any for the underlying ChunkedArray /
1115        // Logical (so not the SeriesWrap).
1116        let Some(ca) = self.as_any().downcast_ref::<ChunkedArray<T>>() else {
1117            panic!(
1118                "implementation error, cannot get ref {:?} from {:?}",
1119                T::get_static_dtype(),
1120                self.dtype()
1121            );
1122        };
1123
1124        ca
1125    }
1126}
1127
1128impl<T: PolarsPhysicalType> AsMut<ChunkedArray<T>> for dyn SeriesTrait + '_ {
1129    fn as_mut(&mut self) -> &mut ChunkedArray<T> {
1130        if !self.as_any_mut().is::<ChunkedArray<T>>() {
1131            panic!(
1132                "implementation error, cannot get ref {:?} from {:?}",
1133                T::get_static_dtype(),
1134                self.dtype()
1135            );
1136        }
1137
1138        // @NOTE: SeriesTrait `as_any` returns a std::any::Any for the underlying ChunkedArray /
1139        // Logical (so not the SeriesWrap).
1140        self.as_any_mut().downcast_mut::<ChunkedArray<T>>().unwrap()
1141    }
1142}
1143
1144#[cfg(test)]
1145mod test {
1146    use crate::prelude::*;
1147    use crate::series::*;
1148
1149    #[test]
1150    fn cast() {
1151        let ar = UInt32Chunked::new("a".into(), &[1, 2]);
1152        let s = ar.into_series();
1153        let s2 = s.cast(&DataType::Int64).unwrap();
1154
1155        assert!(s2.i64().is_ok());
1156        let s2 = s.cast(&DataType::Float32).unwrap();
1157        assert!(s2.f32().is_ok());
1158    }
1159
1160    #[test]
1161    fn new_series() {
1162        let _ = Series::new("boolean series".into(), &vec![true, false, true]);
1163        let _ = Series::new("int series".into(), &[1, 2, 3]);
1164        let ca = Int32Chunked::new("a".into(), &[1, 2, 3]);
1165        let _ = ca.into_series();
1166    }
1167
1168    #[test]
1169    #[cfg(feature = "dtype-date")]
1170    fn roundtrip_list_logical_20311() {
1171        let list = ListChunked::from_chunk_iter(
1172            PlSmallStr::from_static("a"),
1173            [ListArray::new(
1174                ArrowDataType::LargeList(Box::new(ArrowField::new(
1175                    LIST_VALUES_NAME,
1176                    ArrowDataType::Int32,
1177                    true,
1178                ))),
1179                unsafe { Offsets::new_unchecked(vec![0, 1]) }.into(),
1180                PrimitiveArray::new(ArrowDataType::Int32, vec![1i32].into(), None).to_boxed(),
1181                None,
1182            )],
1183        );
1184        let list = unsafe { list.from_physical_unchecked(DataType::Date) }.unwrap();
1185        assert_eq!(list.dtype(), &DataType::List(Box::new(DataType::Date)));
1186    }
1187
1188    #[test]
1189    #[cfg(feature = "dtype-struct")]
1190    fn new_series_from_empty_structs() {
1191        let dtype = DataType::Struct(vec![]);
1192        let empties = vec![AnyValue::StructOwned(Box::new((vec![], vec![]))); 3];
1193        let s = Series::from_any_values_and_dtype("".into(), &empties, &dtype, false).unwrap();
1194        assert_eq!(s.len(), 3);
1195    }
1196    #[test]
1197    fn new_series_from_arrow_primitive_array() {
1198        let array = UInt32Array::from_slice([1, 2, 3, 4, 5]);
1199        let array_ref: ArrayRef = Box::new(array);
1200
1201        let _ = Series::try_new("foo".into(), array_ref).unwrap();
1202    }
1203
1204    #[test]
1205    fn series_append() {
1206        let mut s1 = Series::new("a".into(), &[1, 2]);
1207        let s2 = Series::new("b".into(), &[3]);
1208        s1.append(&s2).unwrap();
1209        assert_eq!(s1.len(), 3);
1210
1211        // add wrong type
1212        let s2 = Series::new("b".into(), &[3.0]);
1213        assert!(s1.append(&s2).is_err())
1214    }
1215
1216    #[test]
1217    #[cfg(feature = "dtype-decimal")]
1218    fn series_append_decimal() {
1219        let s1 = Series::new("a".into(), &[1.1, 2.3])
1220            .cast(&DataType::Decimal(38, 2))
1221            .unwrap();
1222        let s2 = Series::new("b".into(), &[3])
1223            .cast(&DataType::Decimal(38, 0))
1224            .unwrap();
1225
1226        {
1227            let mut s1 = s1.clone();
1228            s1.append(&s2).unwrap();
1229            assert_eq!(s1.len(), 3);
1230            assert_eq!(s1.get(2).unwrap(), AnyValue::Decimal(300, 38, 2));
1231        }
1232
1233        {
1234            let mut s2 = s2;
1235            s2.extend(&s1).unwrap();
1236            assert_eq!(s2.get(2).unwrap(), AnyValue::Decimal(2, 38, 0));
1237        }
1238    }
1239
1240    #[test]
1241    fn series_slice_works() {
1242        let series = Series::new("a".into(), &[1i64, 2, 3, 4, 5]);
1243
1244        let slice_1 = series.slice(-3, 3);
1245        let slice_2 = series.slice(-5, 5);
1246        let slice_3 = series.slice(0, 5);
1247
1248        assert_eq!(slice_1.get(0).unwrap(), AnyValue::Int64(3));
1249        assert_eq!(slice_2.get(0).unwrap(), AnyValue::Int64(1));
1250        assert_eq!(slice_3.get(0).unwrap(), AnyValue::Int64(1));
1251    }
1252
1253    #[test]
1254    fn out_of_range_slice_does_not_panic() {
1255        let series = Series::new("a".into(), &[1i64, 2, 3, 4, 5]);
1256
1257        let _ = series.slice(-3, 4);
1258        let _ = series.slice(-6, 2);
1259        let _ = series.slice(4, 2);
1260    }
1261}
polars_core/series/mod.rs

polars_core/series/
mod.rs
