Struct NullChunked 

pub struct NullChunked { /* private fields */ }

Implementations

impl NullChunked

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl AggList for NullChunked

unsafe fn agg_list(&self, groups: &GroupsType) -> Series

Safety

impl ChunkAnyValue for NullChunked

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

Get a single value. Beware this is slow. If you need to use this slightly performant, cast Categorical to UInt32

fn get_any_value(&self, _index: usize) -> Result<AnyValue<'_>, PolarsError>

Get a single value. Beware this is slow.

impl ChunkCompareEq<&NullChunked> for NullChunked

type Item = ChunkedArray<BooleanType>

fn equal( &self, rhs: &NullChunked, ) -> <NullChunked as ChunkCompareEq<&NullChunked>>::Item

Check for equality.

fn equal_missing( &self, rhs: &NullChunked, ) -> <NullChunked as ChunkCompareEq<&NullChunked>>::Item

Check for equality where None == None.

fn not_equal( &self, rhs: &NullChunked, ) -> <NullChunked as ChunkCompareEq<&NullChunked>>::Item

Check for inequality.

fn not_equal_missing( &self, rhs: &NullChunked, ) -> <NullChunked as ChunkCompareEq<&NullChunked>>::Item

Check for inequality where None == None.

impl ChunkCompareIneq<&NullChunked> for NullChunked

type Item = ChunkedArray<BooleanType>

fn gt( &self, rhs: &NullChunked, ) -> <NullChunked as ChunkCompareIneq<&NullChunked>>::Item

Greater than comparison.

fn gt_eq( &self, rhs: &NullChunked, ) -> <NullChunked as ChunkCompareIneq<&NullChunked>>::Item

Greater than or equal comparison.

fn lt( &self, rhs: &NullChunked, ) -> <NullChunked as ChunkCompareIneq<&NullChunked>>::Item

Less than comparison.

fn lt_eq( &self, rhs: &NullChunked, ) -> <NullChunked as ChunkCompareIneq<&NullChunked>>::Item

Less than or equal comparison

impl ChunkNestingUtils for NullChunked

fn propagate_nulls(&self) -> Option<NullChunked>

Propagate nulls of nested datatype to all levels of nesting.

fn trim_lists_to_normalized_offsets(&self) -> Option<NullChunked>

Trim all lists of unused start and end elements recursively.

fn find_validity_mismatch(&self, other: &Series, idxs: &mut Vec<u32>)

Find the indices of the values where the validity mismatches.

impl Clone for NullChunked

fn clone(&self) -> NullChunked

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl IntoSeries for NullChunked

fn into_series(self) -> Series

where NullChunked: Sized,

fn is_series() -> bool

impl SeriesTrait for NullChunked

fn name(&self) -> &PlSmallStr

Name of series.

fn rename(&mut self, name: PlSmallStr)

Rename the Series.

fn chunks(&self) -> &Vec<Box<dyn Array>>

Underlying chunks.

unsafe fn chunks_mut(&mut self) -> &mut Vec<Box<dyn Array>>

Underlying chunks.

fn chunk_lengths( &self, ) -> Map<Iter<'_, Box<dyn Array>>, fn(&Box<dyn Array>) -> usize>

Get the lengths of the underlying chunks

fn take( &self, indices: &ChunkedArray<UInt32Type>, ) -> Result<Series, PolarsError>

Take from self at the indexes given by idx.

unsafe fn take_unchecked(&self, indices: &ChunkedArray<UInt32Type>) -> Series

Take from self at the indexes given by idx.

fn take_slice(&self, indices: &[u32]) -> Result<Series, PolarsError>

Take from self at the indexes given by idx.

unsafe fn take_slice_unchecked(&self, indices: &[u32]) -> Series

Take from self at the indexes given by idx.

fn deposit(&self, validity: &Bitmap) -> Series

fn len(&self) -> usize

Get length of series.

fn has_nulls(&self) -> bool

Return if any the chunks in this ChunkedArray have nulls.

fn rechunk(&self) -> Series

Aggregate all chunks to a contiguous array of memory.

fn drop_nulls(&self) -> Series

Drop all null values and return a new Series.

fn cast( &self, dtype: &DataType, _cast_options: CastOptions, ) -> Result<Series, PolarsError>

fn null_count(&self) -> usize

Count the null values.

fn unique(&self) -> Result<Series, PolarsError>

Get unique values in the Series.

fn n_unique(&self) -> Result<usize, PolarsError>

Get unique values in the Series.

fn arg_unique(&self) -> Result<ChunkedArray<UInt32Type>, PolarsError>

Get first indexes of unique values.

fn unique_id(&self) -> Result<(u32, Vec<u32>), PolarsError>

Get dense ids for each unique value.

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

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

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.

fn slice(&self, offset: i64, length: usize) -> Series

Get a zero copy view of the data.

fn split_at(&self, offset: i64) -> (Series, Series)

Get a zero copy view of the data.

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

fn arg_sort(&self, _options: SortOptions) -> ChunkedArray<UInt32Type>

Retrieve the indexes needed for a sort.

fn is_null(&self) -> ChunkedArray<BooleanType>

Get a mask of the null values.

fn is_not_null(&self) -> ChunkedArray<BooleanType>

Get a mask of the non-null values.

fn reverse(&self) -> Series

return a Series in reversed order

fn filter( &self, filter: &ChunkedArray<BooleanType>, ) -> Result<Series, PolarsError>

Filter by boolean mask. This operation clones data.

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.

fn sum_reduce(&self) -> Result<Scalar, PolarsError>

Get the sum of the Series as a new Scalar.

fn min_reduce(&self) -> Result<Scalar, PolarsError>

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

fn max_reduce(&self) -> Result<Scalar, PolarsError>

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

fn mean_reduce(&self) -> Result<Scalar, PolarsError>

Get the mean of the Series as a new Scalar

fn median_reduce(&self) -> Result<Scalar, PolarsError>

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

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

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

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

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

fn append(&mut self, other: &Series) -> Result<(), PolarsError>

fn append_owned(&mut self, other: Series) -> Result<(), PolarsError>

fn approx_n_unique(&self) -> Result<u32, PolarsError>

Available on crate feature approx_unique only.

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

Clone inner ChunkedArray and wrap in a new Arc

fn find_validity_mismatch(&self, other: &Series, idxs: &mut Vec<u32>)

Find the indices of elements where the null masks are different recursively.

fn as_any(&self) -> &(dyn Any + 'static)

Get a hold of the ChunkedArray, Logical or NullChunked as an Any trait reference.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Get a hold of the ChunkedArray, Logical or NullChunked as an Any trait mutable reference.

fn as_phys_any(&self) -> &(dyn Any + 'static)

Get a hold of the ChunkedArray or NullChunked as an Any trait reference. This pierces through Logical types to get the underlying physical array.

fn as_arc_any(self: Arc<NullChunked>) -> Arc<dyn Any + Send + Sync>

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

Get field (used in schema)

fn dtype(&self) -> &DataType

Get datatype of series.

fn n_chunks(&self) -> usize

Number of chunks in this Series

fn shrink_to_fit(&mut self)

Shrink the capacity of this array to fit its length.

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

Take num_elements from the top as a zero copy view.

fn is_empty(&self) -> bool

Check if Series is empty.

fn rechunk_validity(&self) -> Option<Bitmap>

fn _sum_as_f64(&self) -> f64

Returns the sum of the array as an f64.

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

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

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

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

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

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

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

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

fn trim_lists_to_normalized_offsets(&self) -> Option<Series>

Trim all lists of unused start and end elements recursively.

fn propagate_nulls(&self) -> Option<Series>

Propagate down nulls in nested types.

fn get(&self, index: usize) -> Result<AnyValue<'_>, PolarsError>

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

fn as_single_ptr(&mut self) -> Result<usize, PolarsError>

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

fn quantile_reduce( &self, _quantile: f64, _method: QuantileMethod, ) -> Result<Scalar, PolarsError>

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

fn quantiles_reduce( &self, _quantiles: &[f64], _method: QuantileMethod, ) -> Result<Scalar, PolarsError>

Get multiple quantiles of the ChunkedArray as a new List Scalar

fn and_reduce(&self) -> Result<Scalar, PolarsError>

Get the bitwise AND of the Series as a new Series of length 1,

fn or_reduce(&self) -> Result<Scalar, PolarsError>

Get the bitwise OR of the Series as a new Series of length 1,

fn xor_reduce(&self) -> Result<Scalar, PolarsError>

Get the bitwise XOR of the Series as a new Series of length 1,

fn first(&self) -> Scalar

Get the first element of the Series as a Scalar

fn first_non_null(&self) -> Scalar

Get the first non-null element of the Series as a Scalar

fn last(&self) -> Scalar

Get the last element of the Series as a Scalar

fn last_non_null(&self) -> Scalar

Get the last non-null element of the Series as a Scalar

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

Available on crate feature object only.

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

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

Available on crate feature object only.

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

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

Available on crate feature checked_arithmetic only.

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

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.

impl VecHash for NullChunked

fn vec_hash( &self, random_state: SeedableRandomState, buf: &mut Vec<u64>, ) -> Result<(), PolarsError>

Compute the hash for all values in the array.

fn vec_hash_combine( &self, random_state: SeedableRandomState, hashes: &mut [u64], ) -> Result<(), PolarsError>