Type Alias polars_core :: datatypes :: StringChunked Copy item path

impl StringChunked

pub fn apply_mut<'a, F>(&'a self, f: F) -> Self
where F: FnMut(&'a str) -> &'a str,

pub fn apply_to_buffer<'a, F>(&'a self, f: F) -> Self
where F: FnMut(&'a str, &mut String),

Utility that reuses an string buffer to amortize allocations. Prefer this over an apply that returns an owned String.

impl StringChunked

pub fn to_decimal(&self, infer_length: usize) -> PolarsResult<Series>

Available on crate feature dtype-decimal only.

Convert an StringChunked to a Series of DataType::Decimal. Scale needed for the decimal type are inferred. Parsing is not strict.
Scale inference assumes that all tested strings are well-formed numbers, and may produce unexpected results for scale if this is not the case.

If the decimal precision and scale are already known, consider using the cast method.

pub fn par_iter_indexed( &self ) -> impl IndexedParallelIterator<Item = Option<&str>>

pub fn par_iter(&self) -> impl ParallelIterator<Item = Option<&str>> + '_

Trait Implementations§

impl Add<&str> for &StringChunked

type Output = ChunkedArray<StringType>

The resulting type after applying the + operator.

fn add(self, rhs: &str) -> Self::Output

Performs the + operation. Read more

impl Add for &StringChunked

type Output = ChunkedArray<StringType>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation. Read more

impl Add for StringChunked

type Output = ChunkedArray<StringType>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation. Read more

impl AggList for StringChunked

Available on crate feature algorithm_group_by only.

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

Safety Read more

impl ChunkAggSeries for StringChunked

fn max_reduce(&self) -> Scalar

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

fn min_reduce(&self) -> Scalar

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

fn sum_reduce(&self) -> Scalar

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

fn prod_reduce(&self) -> Scalar

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

impl ChunkAnyValue for StringChunked

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 Read more

fn get_any_value(&self, index: usize) -> PolarsResult<AnyValue<'_>>

Get a single value. Beware this is slow.

impl<'a> ChunkApply<'a, &'a str> for StringChunked

type FuncRet = Cow<'a, str>

fn apply_values<F>(&'a self, f: F) -> Self
where F: Fn(&'a str) -> Cow<'a, str> + Copy,

Apply a closure elementwise. This is fastest when the null check branching is more expensive than the closure application. Often it is. Read more

fn apply<F>(&'a self, f: F) -> Self
where F: Fn(Option<&'a str>) -> Option<Cow<'a, str>> + Copy,

Apply a closure elementwise including null values.

fn apply_to_slice<F, T>(&'a self, f: F, slice: &mut [T])
where F: Fn(Option<&'a str>, &T) -> T,

Apply a closure elementwise and write results to a mutable slice.

impl ChunkApplyKernel<BinaryViewArrayGeneric<str>> for StringChunked

fn apply_kernel(&self, f: &dyn Fn(&Utf8ViewArray) -> ArrayRef) -> Self

Apply kernel and return result as a new ChunkedArray.

fn apply_kernel_cast<S>( &self, f: &dyn Fn(&Utf8ViewArray) -> ArrayRef ) -> ChunkedArray<S>
where S: PolarsDataType,

Apply a kernel that outputs an array of different type.

impl ChunkCast for StringChunked

fn cast_with_options( &self, data_type: &DataType, options: CastOptions ) -> PolarsResult<Series>

Cast a ChunkedArray to DataType

unsafe fn cast_unchecked(&self, data_type: &DataType) -> PolarsResult<Series>

Does not check if the cast is a valid one and may over/underflow Read more

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

Cast a ChunkedArray to DataType

impl ChunkCompare<&ChunkedArray<StringType>> for StringChunked

type Item = ChunkedArray<BooleanType>

fn equal(&self, rhs: &StringChunked) -> BooleanChunked

Check for equality.

fn equal_missing(&self, rhs: &StringChunked) -> BooleanChunked

Check for equality where None == None.

fn not_equal(&self, rhs: &StringChunked) -> BooleanChunked

Check for inequality.

fn not_equal_missing(&self, rhs: &StringChunked) -> BooleanChunked

Check for inequality where None == None.

fn gt(&self, rhs: &StringChunked) -> BooleanChunked

Greater than comparison.

fn gt_eq(&self, rhs: &StringChunked) -> BooleanChunked

Greater than or equal comparison.

fn lt(&self, rhs: &StringChunked) -> BooleanChunked

Less than comparison.

fn lt_eq(&self, rhs: &StringChunked) -> BooleanChunked

Less than or equal comparison

impl ChunkCompare<&str> for StringChunked

type Item = ChunkedArray<BooleanType>

fn equal(&self, rhs: &str) -> BooleanChunked

Check for equality.

fn equal_missing(&self, rhs: &str) -> BooleanChunked

Check for equality where None == None.

fn not_equal(&self, rhs: &str) -> BooleanChunked

Check for inequality.

fn not_equal_missing(&self, rhs: &str) -> BooleanChunked

Check for inequality where None == None.

fn gt(&self, rhs: &str) -> BooleanChunked

Greater than comparison.

fn gt_eq(&self, rhs: &str) -> BooleanChunked

Greater than or equal comparison.

fn lt(&self, rhs: &str) -> BooleanChunked

Less than comparison.

fn lt_eq(&self, rhs: &str) -> BooleanChunked

Less than or equal comparison

impl ChunkExpandAtIndex<StringType> for StringChunked

fn new_from_index(&self, index: usize, length: usize) -> StringChunked

Create a new ChunkedArray filled with values at that index.

impl ChunkFilter<StringType> for StringChunked

fn filter( &self, filter: &BooleanChunked ) -> PolarsResult<ChunkedArray<StringType>>

Filter values in the ChunkedArray with a boolean mask. Read more

impl<'a> ChunkFull<&'a str> for StringChunked

fn full(name: &str, value: &'a str, length: usize) -> Self

Create a ChunkedArray with a single value.

impl ChunkFullNull for StringChunked

fn full_null(name: &str, length: usize) -> Self

impl ChunkQuantile<String> for StringChunked

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

Returns the mean value in the array. Returns None if the array is empty or only contains null values.

fn quantile( &self, _quantile: f64, _interpol: QuantileInterpolOptions ) -> PolarsResult<Option<T>>

Aggregate a given quantile of the ChunkedArray. Returns None if the array is empty or only contains null values.

impl ChunkReverse for StringChunked

fn reverse(&self) -> Self

Return a reversed version of this array.

impl<'a> ChunkSet<'a, &'a str, String> for StringChunked

fn scatter_single<I: IntoIterator<Item = IdxSize>>( &'a self, idx: I, opt_value: Option<&'a str> ) -> PolarsResult<Self>
where Self: Sized,

Set the values at indexes idx to some optional value Option<T>. Read more

fn scatter_with<I: IntoIterator<Item = IdxSize>, F>( &'a self, idx: I, f: F ) -> PolarsResult<Self>
where Self: Sized, F: Fn(Option<&'a str>) -> Option<String>,

Set the values at indexes idx by applying a closure to these values. Read more

fn set( &'a self, mask: &BooleanChunked, value: Option<&'a str> ) -> PolarsResult<Self>
where Self: Sized,

Set the values where the mask evaluates to true to some optional value Option<T>. Read more

impl ChunkShift<StringType> for StringChunked

fn shift(&self, periods: i64) -> Self

impl ChunkShiftFill<StringType, Option<&str>> for StringChunked

fn shift_and_fill( &self, periods: i64, fill_value: Option<&str> ) -> StringChunked

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

impl ChunkSort<StringType> for StringChunked

fn arg_sort_multiple( &self, by: &[Series], options: &SortMultipleOptions ) -> PolarsResult<IdxCa>

§Panics

This function is very opinionated. On the implementation of ChunkedArray<T> for numeric types, we assume that all numeric Series are of the same type.

In this case we assume that all numeric Series are f64 types. The caller needs to uphold this contract. If not, it will panic.

fn sort_with(&self, options: SortOptions) -> ChunkedArray<StringType>

fn sort(&self, descending: bool) -> StringChunked

Returned a sorted ChunkedArray.

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

Retrieve the indexes needed to sort this array.

impl ChunkTakeUnchecked<ChunkedArray<UInt32Type>> for StringChunked

unsafe fn take_unchecked(&self, indices: &IdxCa) -> Self

Gather values from ChunkedArray by index. Read more

impl<I: AsRef<[IdxSize]> + ?Sized> ChunkTakeUnchecked<I> for StringChunked

unsafe fn take_unchecked(&self, indices: &I) -> Self

Gather values from ChunkedArray by index.

impl ChunkUnique for StringChunked

Available on crate feature algorithm_group_by only.

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

Get unique values of a ChunkedArray

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

Get first index of the unique values in a ChunkedArray. This Vec is sorted.

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

Number of unique values in the ChunkedArray

impl ChunkVar for StringChunked

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

Compute the variance of this ChunkedArray/Series.

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

Compute the standard deviation of this ChunkedArray/Series.

impl Debug for StringChunked

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<Ptr> FromIterator<Option<Ptr>> for StringChunked
where Ptr: AsRef<str>,

fn from_iter<I: IntoIterator<Item = Option<Ptr>>>(iter: I) -> Self

Creates a value from an iterator. Read more

impl<Ptr> FromIterator<Ptr> for StringChunked
where Ptr: PolarsAsRef<str>,

fn from_iter<I: IntoIterator<Item = Ptr>>(iter: I) -> Self

Creates a value from an iterator. Read more

impl<Ptr> FromParallelIterator<Option<Ptr>> for StringChunked
where Ptr: AsRef<str> + Send + Sync,

fn from_par_iter<I: IntoParallelIterator<Item = Option<Ptr>>>(iter: I) -> Self

Creates an instance of the collection from the parallel iterator par_iter. Read more

impl<Ptr> FromParallelIterator<Ptr> for StringChunked
where Ptr: PolarsAsRef<str> + Send + Sync + NoOption,

fn from_par_iter<I: IntoParallelIterator<Item = Ptr>>(iter: I) -> Self

Creates an instance of the collection from the parallel iterator par_iter. Read more

impl<Ptr> FromTrustedLenIterator<Option<Ptr>> for StringChunked
where Ptr: AsRef<str>,

fn from_iter_trusted_length<I: IntoIterator<Item = Option<Ptr>>>( iter: I ) -> Self

impl<Ptr> FromTrustedLenIterator<Ptr> for StringChunked
where Ptr: PolarsAsRef<str>,

fn from_iter_trusted_length<I: IntoIterator<Item = Ptr>>(iter: I) -> Self

impl IntoGroupsProxy for StringChunked

Available on crate feature algorithm_group_by only.

fn group_tuples<'a>( &'a self, multithreaded: bool, sorted: bool ) -> PolarsResult<GroupsProxy>

Create the tuples need for a group_by operation. * The first value in the tuple is the first index of the group. * The second value in the tuple is the indexes of the groups including the first value.

impl<'a> IntoIterator for &'a StringChunked

type Item = Option<&'a str>

The type of the elements being iterated over.

type IntoIter = Box<dyn PolarsIterator<Item = <&'a ChunkedArray<StringType> as IntoIterator>::Item> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

impl<'a, T: AsRef<[&'a str]>> NamedFrom<T, [&'a str]> for StringChunked

fn new(name: &str, v: T) -> Self

Initialize by name and values.

impl<'a, T: AsRef<[Cow<'a, str>]>> NamedFrom<T, [Cow<'a, str>]> for StringChunked

fn new(name: &str, v: T) -> Self

Initialize by name and values.

impl<'a, T: AsRef<[Option<&'a str>]>> NamedFrom<T, [Option<&'a str>]> for StringChunked

fn new(name: &str, v: T) -> Self

Initialize by name and values.

impl<'a, T: AsRef<[Option<Cow<'a, str>>]>> NamedFrom<T, [Option<Cow<'a, str>>]> for StringChunked

fn new(name: &str, v: T) -> Self

Initialize by name and values.

impl<S> NewChunkedArray<StringType, S> for StringChunked
where S: AsRef<str>,

fn from_iter_values(name: &str, it: impl Iterator<Item = S>) -> Self

Create a new ChunkedArray from an iterator.

fn from_slice(name: &str, v: &[S]) -> Self

fn from_slice_options(name: &str, opt_v: &[Option<S>]) -> Self

fn from_iter_options(name: &str, it: impl Iterator<Item = Option<S>>) -> Self

Create a new ChunkedArray from an iterator.

impl ValueSize for StringChunked

fn get_values_size(&self) -> usize

Get the values size that is still “visible” to the underlying array. E.g. take the offsets into account.

impl VecHash for StringChunked

fn vec_hash( &self, random_state: RandomState, buf: &mut Vec<u64> ) -> PolarsResult<()>

Compute the hash for all values in the array. Read more