Trait polars_core::series::SeriesTrait

source ·
pub trait SeriesTrait: Send + Sync + PrivateSeries + PrivateSeriesNumeric {
Show 57 methods // Required methods fn rename(&mut self, name: &str); fn chunk_lengths(&self) -> ChunkLenIter<'_>; fn name(&self) -> &str; fn chunks(&self) -> &Vec<ArrayRef>; unsafe fn chunks_mut(&mut self) -> &mut Vec<ArrayRef>; fn slice(&self, _offset: i64, _length: usize) -> Series; fn filter(&self, _filter: &BooleanChunked) -> PolarsResult<Series>; fn take(&self, _indices: &IdxCa) -> PolarsResult<Series>; unsafe fn take_unchecked(&self, _idx: &IdxCa) -> Series; fn take_slice(&self, _indices: &[IdxSize]) -> PolarsResult<Series>; unsafe fn take_slice_unchecked(&self, _idx: &[IdxSize]) -> Series; fn len(&self) -> usize; fn rechunk(&self) -> Series; fn new_from_index(&self, _index: usize, _length: usize) -> Series; fn cast(&self, _data_type: &DataType) -> PolarsResult<Series>; fn get(&self, _index: usize) -> PolarsResult<AnyValue<'_>>; fn null_count(&self) -> usize; fn has_validity(&self) -> bool; fn is_null(&self) -> BooleanChunked; fn is_not_null(&self) -> BooleanChunked; fn reverse(&self) -> Series; fn shift(&self, _periods: i64) -> Series; fn clone_inner(&self) -> Arc<dyn SeriesTrait>; fn as_any(&self) -> &dyn Any; // Provided methods fn bitand(&self, _other: &Series) -> PolarsResult<Series> { ... } fn bitor(&self, _other: &Series) -> PolarsResult<Series> { ... } fn bitxor(&self, _other: &Series) -> PolarsResult<Series> { ... } fn field(&self) -> Cow<'_, Field> { ... } fn dtype(&self) -> &DataType { ... } fn n_chunks(&self) -> usize { ... } fn shrink_to_fit(&mut self) { ... } fn limit(&self, num_elements: usize) -> Series { ... } fn is_empty(&self) -> bool { ... } fn drop_nulls(&self) -> Series { ... } fn mean(&self) -> Option<f64> { ... } fn std(&self, _ddof: u8) -> Option<f64> { ... } fn var(&self, _ddof: u8) -> Option<f64> { ... } fn median(&self) -> Option<f64> { ... } unsafe fn get_unchecked(&self, _index: usize) -> AnyValue<'_> { ... } fn sort_with(&self, _options: SortOptions) -> PolarsResult<Series> { ... } fn arg_sort(&self, options: SortOptions) -> IdxCa { ... } fn unique(&self) -> PolarsResult<Series> { ... } fn n_unique(&self) -> PolarsResult<usize> { ... } fn arg_unique(&self) -> PolarsResult<IdxCa> { ... } fn as_single_ptr(&mut self) -> PolarsResult<usize> { ... } fn sum_reduce(&self) -> PolarsResult<Scalar> { ... } fn max_reduce(&self) -> PolarsResult<Scalar> { ... } fn min_reduce(&self) -> PolarsResult<Scalar> { ... } fn median_reduce(&self) -> PolarsResult<Scalar> { ... } fn var_reduce(&self, _ddof: u8) -> PolarsResult<Scalar> { ... } fn std_reduce(&self, _ddof: u8) -> PolarsResult<Scalar> { ... } fn quantile_reduce( &self, _quantile: f64, _interpol: QuantileInterpolOptions ) -> PolarsResult<Scalar> { ... } fn get_object(&self, _index: usize) -> Option<&dyn PolarsObjectSafe> { ... } unsafe fn get_object_chunked_unchecked( &self, _chunk: usize, _index: usize ) -> Option<&dyn PolarsObjectSafe> { ... } fn as_any_mut(&mut self) -> &mut dyn Any { ... } fn checked_div(&self, _rhs: &Series) -> PolarsResult<Series> { ... } fn rolling_map( &self, _f: &dyn Fn(&Series) -> Series, _options: RollingOptionsFixedWindow ) -> PolarsResult<Series> { ... }
}

Required Methods§

source

fn rename(&mut self, name: &str)

Rename the Series.

source

fn chunk_lengths(&self) -> ChunkLenIter<'_>

Get the lengths of the underlying chunks

source

fn name(&self) -> &str

Name of series.

source

fn chunks(&self) -> &Vec<ArrayRef>

Underlying chunks.

source

unsafe fn chunks_mut(&mut self) -> &mut Vec<ArrayRef>

Underlying chunks.

§Safety

The caller must ensure the length and the data types of ArrayRef does not change.

source

fn slice(&self, _offset: i64, _length: usize) -> Series

Get a zero copy view of the data.

When offset is negative the offset is counted from the end of the array

source

fn filter(&self, _filter: &BooleanChunked) -> PolarsResult<Series>

Filter by boolean mask. This operation clones data.

source

fn take(&self, _indices: &IdxCa) -> PolarsResult<Series>

Take by index. This operation is clone.

source

unsafe fn take_unchecked(&self, _idx: &IdxCa) -> Series

Take by index.

§Safety

This doesn’t check any bounds.

source

fn take_slice(&self, _indices: &[IdxSize]) -> PolarsResult<Series>

Take by index. This operation is clone.

source

unsafe fn take_slice_unchecked(&self, _idx: &[IdxSize]) -> Series

Take by index.

§Safety

This doesn’t check any bounds.

source

fn len(&self) -> usize

Get length of series.

source

fn rechunk(&self) -> Series

Aggregate all chunks to a contiguous array of memory.

source

fn new_from_index(&self, _index: usize, _length: usize) -> Series

Create a new Series filled with values from the given index.

§Example
use polars_core::prelude::*;
let s = Series::new("a", [0i32, 1, 8]);
let s2 = s.new_from_index(2, 4);
assert_eq!(Vec::from(s2.i32().unwrap()), &[Some(8), Some(8), Some(8), Some(8)])
source

fn cast(&self, _data_type: &DataType) -> PolarsResult<Series>

source

fn get(&self, _index: usize) -> PolarsResult<AnyValue<'_>>

Get a single value by index. Don’t use this operation for loops as a runtime cast is needed for every iteration.

source

fn null_count(&self) -> usize

Count the null values.

source

fn has_validity(&self) -> bool

Return if any the chunks in this [ChunkedArray] have a validity bitmap. no bitmap means no null values.

source

fn is_null(&self) -> BooleanChunked

Get a mask of the null values.

source

fn is_not_null(&self) -> BooleanChunked

Get a mask of the non-null values.

source

fn reverse(&self) -> Series

return a Series in reversed order

source

fn shift(&self, _periods: i64) -> Series

Shift the values by a given period and fill the parts that will be empty due to this operation with Nones.

NOTE: If you want to fill the Nones with a value use the shift operation on ChunkedArray<T>.

§Example
fn example() -> PolarsResult<()> {
    let s = Series::new("series", &[1, 2, 3]);

    let shifted = s.shift(1);
    assert_eq!(Vec::from(shifted.i32()?), &[None, Some(1), Some(2)]);

    let shifted = s.shift(-1);
    assert_eq!(Vec::from(shifted.i32()?), &[Some(2), Some(3), None]);

    let shifted = s.shift(2);
    assert_eq!(Vec::from(shifted.i32()?), &[None, None, Some(1)]);

    Ok(())
}
example();
source

fn clone_inner(&self) -> Arc<dyn SeriesTrait>

Clone inner ChunkedArray and wrap in a new Arc

source

fn as_any(&self) -> &dyn Any

Get a hold to self as Any trait reference.

Provided Methods§

source

fn bitand(&self, _other: &Series) -> PolarsResult<Series>

source

fn bitor(&self, _other: &Series) -> PolarsResult<Series>

source

fn bitxor(&self, _other: &Series) -> PolarsResult<Series>

source

fn field(&self) -> Cow<'_, Field>

Get field (used in schema)

source

fn dtype(&self) -> &DataType

Get datatype of series.

source

fn n_chunks(&self) -> usize

Number of chunks in this Series

source

fn shrink_to_fit(&mut self)

Shrink the capacity of this array to fit its length.

source

fn limit(&self, num_elements: usize) -> Series

Take num_elements from the top as a zero copy view.

source

fn is_empty(&self) -> bool

Check if Series is empty.

source

fn drop_nulls(&self) -> Series

Drop all null values and return a new Series.

source

fn mean(&self) -> Option<f64>

Returns the mean value in the array Returns an option because the array is nullable.

source

fn std(&self, _ddof: u8) -> Option<f64>

Returns the std value in the array Returns an option because the array is nullable.

source

fn var(&self, _ddof: u8) -> Option<f64>

Returns the var value in the array Returns an option because the array is nullable.

source

fn median(&self) -> Option<f64>

Returns the median value in the array Returns an option because the array is nullable.

source

unsafe fn get_unchecked(&self, _index: usize) -> AnyValue<'_>

Get a single value by index. Don’t use this operation for loops as a runtime cast is needed for every iteration.

This may refer to physical types

§Safety

Does not do any bounds checking

source

fn sort_with(&self, _options: SortOptions) -> PolarsResult<Series>

source

fn arg_sort(&self, options: SortOptions) -> IdxCa

Retrieve the indexes needed for a sort.

source

fn unique(&self) -> PolarsResult<Series>

Get unique values in the Series.

source

fn n_unique(&self) -> PolarsResult<usize>

Get unique values in the Series.

source

fn arg_unique(&self) -> PolarsResult<IdxCa>

Get first indexes of unique values.

source

fn as_single_ptr(&mut self) -> PolarsResult<usize>

Rechunk and return a pointer to the start of the Series. Only implemented for numeric types

source

fn sum_reduce(&self) -> PolarsResult<Scalar>

Get the sum of the Series as a new Scalar.

If the DataType is one of {Int8, UInt8, Int16, UInt16} the Series is first cast to Int64 to prevent overflow issues.

source

fn max_reduce(&self) -> PolarsResult<Scalar>

Get the max of the Series as a new Series of length 1.

source

fn min_reduce(&self) -> PolarsResult<Scalar>

Get the min of the Series as a new Series of length 1.

source

fn median_reduce(&self) -> PolarsResult<Scalar>

Get the median of the Series as a new Series of length 1.

source

fn var_reduce(&self, _ddof: u8) -> PolarsResult<Scalar>

Get the variance of the Series as a new Series of length 1.

source

fn std_reduce(&self, _ddof: u8) -> PolarsResult<Scalar>

Get the standard deviation of the Series as a new Series of length 1.

source

fn quantile_reduce( &self, _quantile: f64, _interpol: QuantileInterpolOptions ) -> PolarsResult<Scalar>

Get the quantile of the ChunkedArray as a new Series of length 1.

source

fn get_object(&self, _index: usize) -> Option<&dyn PolarsObjectSafe>

Available on crate feature object only.

Get the value at this index as a downcastable Any trait ref.

source

unsafe fn get_object_chunked_unchecked( &self, _chunk: usize, _index: usize ) -> Option<&dyn PolarsObjectSafe>

Available on crate feature object only.

Get the value at this index as a downcastable Any trait ref.

§Safety

This function doesn’t do any bound checks.

source

fn as_any_mut(&mut self) -> &mut dyn Any

Get a hold to self as Any trait reference. Only implemented for ObjectType

source

fn checked_div(&self, _rhs: &Series) -> PolarsResult<Series>

Available on crate feature checked_arithmetic only.
source

fn rolling_map( &self, _f: &dyn Fn(&Series) -> Series, _options: RollingOptionsFixedWindow ) -> PolarsResult<Series>

Available on crate feature rolling_window only.

Apply a custom function over a rolling/ moving window of the array. This has quite some dynamic dispatch, so prefer rolling_min, max, mean, sum over this.

Implementations§

source§

impl<'a> dyn SeriesTrait + 'a

source

pub fn unpack<N>(&self) -> PolarsResult<&ChunkedArray<N>>
where N: 'static + PolarsDataType,

Trait Implementations§

source§

impl<'a, T> AsMut<ChunkedArray<T>> for dyn SeriesTrait + 'a
where T: 'static + PolarsDataType,

source§

fn as_mut(&mut self) -> &mut ChunkedArray<T>

Converts this type into a mutable reference of the (usually inferred) input type.
source§

impl<'a, T> AsRef<ChunkedArray<T>> for dyn SeriesTrait + 'a
where T: 'static + PolarsDataType,

source§

fn as_ref(&self) -> &ChunkedArray<T>

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl<'a> AsRef<dyn SeriesTrait + 'a> for Series

source§

fn as_ref(&self) -> &(dyn SeriesTrait + 'a)

Converts this type into a shared reference of the (usually inferred) input type.

Implementors§